Audio-SpectraCLI 3.1__tar.gz → 3.2__tar.gz

{Audio_SpectraCLI-3.1 → Audio_SpectraCLI-3.2}/Audio_SpectraCLI.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Audio-SpectraCLI
-Version: 3.1
+Version: 3.2
 Summary: AudioSpectraCLI is a command-line tool that provides real-time FFT visualization of audio spectra. It captures audio input from the microphone and displays the corresponding frequency spectrum directly in the terminal window, allowing users to monitor and analyze audio signals without the need for graphical interfaces.
 Home-page: https://github.com/AdityaSeth777/Audio-SpectraCLI
 Author: Aditya Seth
@@ -20,7 +20,7 @@ License-File: LICENSE
 
 Audio Spectrum Visualization is a Python project that visualizes real-time audio input as a spectrum using Fast Fourier Transform (FFT). It provides an interactive CLI interface for users to start the visualization and exit the program.
 
-## Current Features (with respect to 3.1)
+## Current Features (with respect to 3.2)
 
 - Real-time visualization of Fast Fourier Transform (FFT) spectrum of audio input.
 - Support for adjusting parameters such as duration, sampling rate, and block size.
@@ -35,6 +35,7 @@ Audio-SpectraCLI/
 
 │   CODE_OF_CONDUCT.md
 │   Contributing.md
+│   Dockerfile
 │   LICENSE
 │   Readme.md
 │   requirements.txt
@@ -53,7 +54,7 @@ Audio-SpectraCLI/
         main.py
 ```
 
-## Installation & Usage
+## Installation & Usage (Using PIP)
 
 1. Install using pip
 
@@ -64,7 +65,7 @@ pip install Audio-SpectraCLI
 2. Import and use modules
 
 - Create a Python file.
-- You can use [Example.py](https://github.com/AdityaSeth777/Audio-SpectraCLI/blob/3.1/tests/main.py) as a reference or use the following code :
+- You can use [Example.py](https://github.com/AdityaSeth777/Audio-SpectraCLI/blob/main/tests/main.py) as a reference or use the following code :
 
 ```
 from Audio_SpectraCLI import AudioSpectrumVisualizer
@@ -77,10 +78,97 @@ audio_visualizer = AudioSpectrumVisualizer(
 audio_visualizer.start_visualization()
 ```
 
-- Once you have activated the audio_visualizer instance, feel free to use it wherever in the program. It consists of several parameters (which gives more control to the user), so make sure to configure and add those before using it in your code.
+Once you have activated the audio_visualizer instance, feel free to use it wherever in the program. It consists of several parameters (which gives more control to the user), so make sure to configure and add those before using it in your code.
 
 ---
 
+## Examining & Usage for fun :D (Using Docker)
+
+1. Prerequisites
+   You should have docker installed on your machine. You can download and install Docker from [here](https://www.docker.com/products/docker-desktop).
+2. Pulling the Docker Image
+
+You can pull the pre-built Docker image from Docker Hub using the following command:
+
+```sh
+docker pull adityaseth777/audio-spectracli
+```
+
+3. Viewing Files Inside the Docker Container
+   For seeing the files inside the Docker container for debugging purposes, you can run an interactive shell session:
+
+```sh
+docker run --rm -it --entrypoint /bin/bash audio-spectracli
+```
+
+4. Use the 'ls' command to view the files and get a proper understanding of the file structure :
+
+```sh
+ls
+```
+
+5. You can use [Example.py](https://github.com/AdityaSeth777/Audio-SpectraCLI/blob/main/tests/main.py) as a reference or use the following code :
+
+```
+from Audio_SpectraCLI import AudioSpectrumVisualizer
+
+# Creating an instance of AudioSpectrumVisualizer with custom parameters.
+audio_visualizer = AudioSpectrumVisualizer(
+    duration=5, frequency_range=(50, 5000), color='red')
+
+# Starting the audio spectrum visualization
+audio_visualizer.start_visualization()
+```
+
+Once you have activated the audio_visualizer instance, feel free to use it wherever in the program. It consists of several parameters (which gives more control to the user), so make sure to configure and add those before using it in your code.
+
+---
+
+## Building the Docker Image Locally (for fun :D)
+
+If you prefer to build the Docker image locally, follow these steps:
+
+1. Clone the repository :
+
+```sh
+git clone https://github.com/AdityaSeth777/Audio-SpectraCLI.git
+cd Audio-SpectraCLI
+```
+
+2. Build the Docker image:
+
+```sh
+docker build -t audio-spectracli .
+```
+
+3. Viewing Files Inside the Docker Container
+   For seeing the files inside the Docker container for debugging purposes, you can run an interactive shell session:
+
+```sh
+docker run --rm -it --entrypoint /bin/bash audio-spectracli
+```
+
+4. Use the 'ls' command to view the files and get a proper understanding of the file structure :
+
+```sh
+ls
+```
+
+5. You can use [Example.py](https://github.com/AdityaSeth777/Audio-SpectraCLI/blob/main/tests/main.py) as a reference or use the following code :
+
+```
+from Audio_SpectraCLI import AudioSpectrumVisualizer
+
+# Creating an instance of AudioSpectrumVisualizer with custom parameters.
+audio_visualizer = AudioSpectrumVisualizer(
+    duration=5, frequency_range=(50, 5000), color='red')
+
+# Starting the audio spectrum visualization
+audio_visualizer.start_visualization()
+```
+
+Once you have activated the audio_visualizer instance, feel free to use it wherever in the program. It consists of several parameters (which gives more control to the user), so make sure to configure and add those before using it in your code.
+
 ## Upcoming Features
 
 - CLI endpoints.
@@ -113,7 +201,7 @@ Contact: [contact@adityaseth.in]
 
 ## 🙋‍♂️ Support
 
-💙 If you like this project, give it a ⭐ and share it with friends!<br><br>
+💙 If you like this project, give it a ⭐ and share it with friends!`<br><br>`
 [☕ Buy me a coffee](https://www.buymeacoffee.com/adityaseth)
 
 ---

{Audio_SpectraCLI-3.1 → Audio_SpectraCLI-3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Audio_SpectraCLI
-Version: 3.1
+Version: 3.2
 Summary: AudioSpectraCLI is a command-line tool that provides real-time FFT visualization of audio spectra. It captures audio input from the microphone and displays the corresponding frequency spectrum directly in the terminal window, allowing users to monitor and analyze audio signals without the need for graphical interfaces.
 Home-page: https://github.com/AdityaSeth777/Audio-SpectraCLI
 Author: Aditya Seth
@@ -20,7 +20,7 @@ License-File: LICENSE
 
 Audio Spectrum Visualization is a Python project that visualizes real-time audio input as a spectrum using Fast Fourier Transform (FFT). It provides an interactive CLI interface for users to start the visualization and exit the program.
 
-## Current Features (with respect to 3.1)
+## Current Features (with respect to 3.2)
 
 - Real-time visualization of Fast Fourier Transform (FFT) spectrum of audio input.
 - Support for adjusting parameters such as duration, sampling rate, and block size.
@@ -35,6 +35,7 @@ Audio-SpectraCLI/
 
 │   CODE_OF_CONDUCT.md
 │   Contributing.md
+│   Dockerfile
 │   LICENSE
 │   Readme.md
 │   requirements.txt
@@ -53,7 +54,7 @@ Audio-SpectraCLI/
         main.py
 ```
 
-## Installation & Usage
+## Installation & Usage (Using PIP)
 
 1. Install using pip
 
@@ -64,7 +65,7 @@ pip install Audio-SpectraCLI
 2. Import and use modules
 
 - Create a Python file.
-- You can use [Example.py](https://github.com/AdityaSeth777/Audio-SpectraCLI/blob/3.1/tests/main.py) as a reference or use the following code :
+- You can use [Example.py](https://github.com/AdityaSeth777/Audio-SpectraCLI/blob/main/tests/main.py) as a reference or use the following code :
 
 ```
 from Audio_SpectraCLI import AudioSpectrumVisualizer
@@ -77,10 +78,97 @@ audio_visualizer = AudioSpectrumVisualizer(
 audio_visualizer.start_visualization()
 ```
 
-- Once you have activated the audio_visualizer instance, feel free to use it wherever in the program. It consists of several parameters (which gives more control to the user), so make sure to configure and add those before using it in your code.
+Once you have activated the audio_visualizer instance, feel free to use it wherever in the program. It consists of several parameters (which gives more control to the user), so make sure to configure and add those before using it in your code.
 
 ---
 
+## Examining & Usage for fun :D (Using Docker)
+
+1. Prerequisites
+   You should have docker installed on your machine. You can download and install Docker from [here](https://www.docker.com/products/docker-desktop).
+2. Pulling the Docker Image
+
+You can pull the pre-built Docker image from Docker Hub using the following command:
+
+```sh
+docker pull adityaseth777/audio-spectracli
+```
+
+3. Viewing Files Inside the Docker Container
+   For seeing the files inside the Docker container for debugging purposes, you can run an interactive shell session:
+
+```sh
+docker run --rm -it --entrypoint /bin/bash audio-spectracli
+```
+
+4. Use the 'ls' command to view the files and get a proper understanding of the file structure :
+
+```sh
+ls
+```
+
+5. You can use [Example.py](https://github.com/AdityaSeth777/Audio-SpectraCLI/blob/main/tests/main.py) as a reference or use the following code :
+
+```
+from Audio_SpectraCLI import AudioSpectrumVisualizer
+
+# Creating an instance of AudioSpectrumVisualizer with custom parameters.
+audio_visualizer = AudioSpectrumVisualizer(
+    duration=5, frequency_range=(50, 5000), color='red')
+
+# Starting the audio spectrum visualization
+audio_visualizer.start_visualization()
+```
+
+Once you have activated the audio_visualizer instance, feel free to use it wherever in the program. It consists of several parameters (which gives more control to the user), so make sure to configure and add those before using it in your code.
+
+---
+
+## Building the Docker Image Locally (for fun :D)
+
+If you prefer to build the Docker image locally, follow these steps:
+
+1. Clone the repository :
+
+```sh
+git clone https://github.com/AdityaSeth777/Audio-SpectraCLI.git
+cd Audio-SpectraCLI
+```
+
+2. Build the Docker image:
+
+```sh
+docker build -t audio-spectracli .
+```
+
+3. Viewing Files Inside the Docker Container
+   For seeing the files inside the Docker container for debugging purposes, you can run an interactive shell session:
+
+```sh
+docker run --rm -it --entrypoint /bin/bash audio-spectracli
+```
+
+4. Use the 'ls' command to view the files and get a proper understanding of the file structure :
+
+```sh
+ls
+```
+
+5. You can use [Example.py](https://github.com/AdityaSeth777/Audio-SpectraCLI/blob/main/tests/main.py) as a reference or use the following code :
+
+```
+from Audio_SpectraCLI import AudioSpectrumVisualizer
+
+# Creating an instance of AudioSpectrumVisualizer with custom parameters.
+audio_visualizer = AudioSpectrumVisualizer(
+    duration=5, frequency_range=(50, 5000), color='red')
+
+# Starting the audio spectrum visualization
+audio_visualizer.start_visualization()
+```
+
+Once you have activated the audio_visualizer instance, feel free to use it wherever in the program. It consists of several parameters (which gives more control to the user), so make sure to configure and add those before using it in your code.
+
 ## Upcoming Features
 
 - CLI endpoints.
@@ -113,7 +201,7 @@ Contact: [contact@adityaseth.in]
 
 ## 🙋‍♂️ Support
 
-💙 If you like this project, give it a ⭐ and share it with friends!<br><br>
+💙 If you like this project, give it a ⭐ and share it with friends!`<br><br>`
 [☕ Buy me a coffee](https://www.buymeacoffee.com/adityaseth)
 
 ---

{Audio_SpectraCLI-3.1 → Audio_SpectraCLI-3.2}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = Audio-SpectraCLI
-version = 3.1
+version = 3.2
 author = Aditya Seth
 author_email = contact@adityaseth.in
 description = AudioSpectraCLI is a command-line tool that provides real-time FFT visualization of audio spectra. It captures audio input from the microphone and displays the corresponding frequency spectrum directly in the terminal window, allowing users to monitor and analyze audio signals without the need for graphical interfaces.

{Audio_SpectraCLI-3.1 → Audio_SpectraCLI-3.2}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name="Audio_SpectraCLI",
-    version="3.1",
+    version="3.2",
     author="Aditya Seth",
     long_description=open("Readme.md", encoding="utf-8").read(),
     long_description_content_type="text/markdown",