Metadata-Version: 2.4
Name: zenix
Version: 0.4
Summary: Zenix: A Lightweight Tool for Procedural Noise Generation
Home-page: https://github.com/sepandhaghighi/zenix
Download-URL: https://github.com/sepandhaghighi/zenix/tarball/v0.4
Author: Sepand Haghighi
Author-email: me@sepand.tech
License: MIT
Project-URL: Source, https://github.com/sepandhaghighi/zenix
Keywords: noise white-noise pink-noise brown-noise audio sound dsp signal-processing cli productivity focus relaxation numpy
Classifier: Development Status :: 3 - Alpha
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Other Audience
Classifier: Topic :: Multimedia :: Sound/Audio
Classifier: Topic :: Multimedia :: Sound/Audio :: Sound Synthesis
Classifier: Topic :: Utilities
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: AUTHORS.md
Requires-Dist: numpy>=1.20.0
Requires-Dist: nava>=0.4
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: download-url
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary


<div align="center">
<img src="https://github.com/sepandhaghighi/zenix/raw/main/otherfiles/logo.png" width="350">
<h1>Zenix: A Lightweight Tool for Procedural Noise Generation</h1>
<br/>
<a href="https://www.python.org/"><img src="https://img.shields.io/badge/built%20with-Python3-green.svg" alt="built with Python3"></a>
<a href="https://github.com/sepandhaghighi/zenix"><img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/sepandhaghighi/zenix"></a>
<a href="https://badge.fury.io/py/zenix"><img src="https://badge.fury.io/py/zenix.svg" alt="PyPI version"></a>
<a href="https://codecov.io/gh/sepandhaghighi/zenix"><img src="https://codecov.io/gh/sepandhaghighi/zenix/graph/badge.svg?token=BxLx6eb3sI"></a>
</div>			
				
## Overview	

<p align="justify">		
Zenix is a lightweight tool for generating procedural noise such as white, pink, and brown noise. It can be used both as a command-line application and as a Python library, making it suitable for quick terminal usage as well as integration into Python projects. Zenix generates noise programmatically using NumPy and plays it through an audio backend, allowing developers to create continuous background sound for focus, concentration, relaxation, or acoustic masking. With support for multiple noise types, configurable parameters, fade-in effects, and looping playback, Zenix provides a simple yet flexible way to work with procedural noise in both interactive and programmatic environments.
</p>

<table>
	<tr>
		<td align="center">PyPI Counter</td>
		<td align="center"><a href="http://pepy.tech/project/zenix"><img src="http://pepy.tech/badge/zenix"></a></td>
	</tr>
	<tr>
		<td align="center">Github Stars</td>
		<td align="center"><a href="https://github.com/sepandhaghighi/zenix"><img src="https://img.shields.io/github/stars/sepandhaghighi/zenix.svg?style=social&label=Stars"></a></td>
	</tr>
</table>



<table>
	<tr> 
		<td align="center">Branch</td>
		<td align="center">main</td>	
		<td align="center">dev</td>	
	</tr>
	<tr>
		<td align="center">CI</td>
		<td align="center"><img src="https://github.com/sepandhaghighi/zenix/actions/workflows/test.yml/badge.svg?branch=main"></td>
		<td align="center"><img src="https://github.com/sepandhaghighi/zenix/actions/workflows/test.yml/badge.svg?branch=dev"></td>
	</tr>
</table>

<table>
    <tr> 
        <td align="center">Code Quality</td>
        <td align="center"><a href="https://app.codacy.com/gh/sepandhaghighi/zenix/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade"><img src="https://app.codacy.com/project/badge/Grade/c054b58a766d4251802e6bc7df8f8e95"></a></td>
        <td align="center"><a href="https://www.codefactor.io/repository/github/sepandhaghighi/zenix"><img src="https://www.codefactor.io/repository/github/sepandhaghighi/zenix/badge" alt="CodeFactor"></a></td>
    </tr>
</table>

## Installation		

### Source Code
- Download [Version 0.4](https://github.com/sepandhaghighi/zenix/archive/v0.4.zip) or [Latest Source](https://github.com/sepandhaghighi/zenix/archive/dev.zip)
- `pip install .`				

### PyPI

- Check [Python Packaging User Guide](https://packaging.python.org/installing/)     
- `pip install zenix==0.4`						


## Usage

### CLI

```bash
zenix --type=white --duration=120 --volume=0.25 --fade-in=2 --fade-out=3 --sample-rate=44000 --loop
```

#### Arguments

| Argument | Description | Default |
|----------|-------------|---------|
| `--type` | Noise type  | `white` |
| `--duration` | Duration of generated noise in seconds | `30` |
| `--volume` | Output volume multiplier | `0.3` |
| `--fade-in` | Fade-in duration in seconds | `2` |
| `--fade-out` | Fade-out duration in seconds | `2` |
| `--sample-rate` | Audio sample rate in Hz | `44100` |
| `--loop` | Enable continuous looping playback | `False` |


### Library

```python
from zenix import generate_noise, play_noise, NoiseType
audio = generate_noise(
        noise_type=NoiseType.WHITE,
        duration=120,
        sample_rate=44000,
        volume=0.25,
        fade_in=2,
		fade_out=2
    )
play_noise(audio=audio, sample_rate=44000, loop=True)
```

#### Parameters

| Parameter | Description | Default |
|-----------|-------------|---------|
| `noise_type` | Noise type | `NoiseType.WHITE` |
| `duration` | Duration of generated noise in seconds | `30` |
| `sample_rate` | Audio sample rate in Hz | `44100` |
| `volume` | Output volume multiplier | `0.3` |
| `fade_in` | Fade-in duration in seconds | `2` |
| `fade_out` | Fade-out duration in seconds | `2` |

## Issues & Bug Reports			

Just fill an issue and describe it. We'll check it ASAP!

- Please complete the issue template

## Show Your Support
								
<h3>Star This Repo</h3>					

Give a ⭐️ if this project helped you!

<h3>Donate to Our Project</h3>	

<h4>Bitcoin</h4>
1KtNLEEeUbTEK9PdN6Ya3ZAKXaqoKUuxCy
<h4>Ethereum</h4>
0xcD4Db18B6664A9662123D4307B074aE968535388
<h4>Litecoin</h4>
Ldnz5gMcEeV8BAdsyf8FstWDC6uyYR6pgZ
<h4>Doge</h4>
DDUnKpFQbBqLpFVZ9DfuVysBdr249HxVDh
<h4>Tron</h4>
TCZxzPZLcJHr2qR3uPUB1tXB6L3FDSSAx7
<h4>Ripple</h4>
rN7ZuRG7HDGHR5nof8nu5LrsbmSB61V1qq
<h4>Binance Coin</h4>
bnb1zglwcf0ac3d0s2f6ck5kgwvcru4tlctt4p5qef
<h4>Tether</h4>
0xcD4Db18B6664A9662123D4307B074aE968535388
<h4>Dash</h4>
Xd3Yn2qZJ7VE8nbKw2fS98aLxR5M6WUU3s
<h4>Stellar</h4>		
GALPOLPISRHIYHLQER2TLJRGUSZH52RYDK6C3HIU4PSMNAV65Q36EGNL
<h4>Zilliqa</h4>
zil1knmz8zj88cf0exr2ry7nav9elehxfcgqu3c5e5
<h4>Coffeete</h4>
<a href="http://www.coffeete.ir/opensource">
<img src="http://www.coffeete.ir/images/buttons/lemonchiffon.png" style="width:260px;" />
</a>


# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [Unreleased]
## [0.4] - 2026-04-26
### Added
- `fade_out` parameter
- `--fade-out` argument
### Changed
- `README.md` updated
- Test system modified
## [0.3] - 2026-04-21
### Added
- Input validation
- Logo
### Changed
- Test system modified
## [0.2] - 2026-04-13
### Added
- `--sample-rate` argument
### Changed
- `README.md` updated
- Test system modified
## [0.1] - 2026-04-03
### Added
- `generate_noise` function
- `play_noise` function
- White noise
- Pink noise
- Brown noise

[Unreleased]: https://github.com/sepandhaghighi/zenix/compare/v0.4...dev
[0.4]: https://github.com/sepandhaghighi/zenix/compare/v0.3...v0.4
[0.3]: https://github.com/sepandhaghighi/zenix/compare/v0.2...v0.3
[0.2]: https://github.com/sepandhaghighi/zenix/compare/v0.1...v0.2
[0.1]: https://github.com/sepandhaghighi/zenix/compare/815762c...v0.1



