Merge pull request #9 from AdityaSeth777/Dev-4.1.0

Feature Addition: Audio-SpectraCLI VS Code Extension

.github/dependabot.yml

@@ -8,4 +8,4 @@ updates:
   - package-ecosystem: "pip" # See documentation for possible values
     directory: "/" # Location of package manifests
     schedule:
-      interval: "weekly"
+      interval: "weekly"

CHANGELOG.md

@@ -0,0 +1,35 @@
+# Changelog 📝
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+* 
+
+## [version] - 2024-11-07
+
+### Added
+
+* 
+
+### Changed
+
+* 
+
+### Fixed
+
+* 
+
+### Deprecated
+
+* 
+
+### Removed
+
+* 
+
+### Security
+
+* 

MANIFEST.in

@@ -0,0 +1 @@
+include Readme.md

Readme.md

@@ -7,6 +7,12 @@
                                       |_|
 ```
 
+<div align=center>
+
+[![cover.png](https://i.postimg.cc/1t7F1J9j/cover.png)](https://postimg.cc/bDbrQ0Sx)
+
+</div>
+
 ## 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 and dynamic interface for users to start the visualization and exit the program.
 
  <p>
@@ -30,9 +36,10 @@
 
 ### The [&#39;main-old.py&#39;](./Audio_SpectraCLI/main-old.py), which is the code for the main file for v3.2, and the [&#39;test-old.py&#39;](./tests/test-old.py) case supporting that, is DEPRECATED.
 
-## Current Features (with respect to 4.0.1)
+## Current Features (with respect to 4.1.0)
 
 - Real-time visualization of Fast Fourier Transform (FFT) spectrum of audio input.
+- Live VS Code Extension support.
 - Support for adjusting parameters such as duration, sampling rate, and block size.
 - Seamless integration with SoundDevice for audio input capture.
 - Customizable Frequency Range: Allow users to specify the frequency range to display in the spectrum.
@@ -65,15 +72,122 @@ Audio-SpectraCLI/
 │   ├── main.py
 │   └── __init__.py
 └── tests/
-    ├── test-old.py
-    └── test.py
+├── ├── test-old.py
+├── └── test.py
+└── audiospectra-cli/
+    ├── assets
+    ├── dist
+    ├── src/
+    │   ├── test
+    │   ├── extension.test.ts
+    │   └── extension.ts
+    ├── audio-spectracli-extension-v.vsix
+    ├── CHANGELOG.md
+    ├── ebuild.js
+    ├── eslint.config.mjs
+    ├── package.json
+    ├── package-lock.json
+    ├── README.md
+    ├── sample.py
+    └── tsconfig.json
+```
+
+## Installation Methods : (Now Extension available)
+
+<details>
+
+<summary> Installation & Usage (Using VSCode Extensions - Marketplace)</summary>
+
+# How to Use the Audio-SpectraCLI Extension
+
+Follow these steps to use the Audio-SpectraCLI extension in Visual Studio Code:
+
+1. **Open Visual Studio Code**
+   - Launch VS Code on your computer (macOS, Windows, or Linux).
+
+2. **Install the Audio-SpectraCLI Extension**
+   - Go to the Extensions sidebar by clicking on the Extensions icon in the Activity Bar (or press `Ctrl+Shift+X` on Windows/Linux or `Cmd+Shift+X` on macOS).
+   - Search for "Audio-SpectraCLI" in the Extensions Marketplace.
+   - Click **Install** next to the Audio-SpectraCLI extension.
+
+3. **Activate the Extension**
+   - After installation, open the Command Palette by pressing `F1` or `Ctrl+Shift+P` on Windows/Linux or `Cmd+Shift+P` on macOS.
+   - Type `>Audio-SpectraCLI: Add Sample Code` or `>Audio-SpectraCLI: View Status`.
+   - Select either command to activate and use the extension.
+
+4. **Using the Commands**
+   - **Add Sample Code**: Inserts sample code for Audio-SpectraCLI into the current editor window.
+     - Open any Python file or create a new one.
+     - Run the command `Audio-SpectraCLI: Add Sample Code` from the Command Palette.
+     - The sample code should appear in the editor.
+   - **View Extension Status**: Displays the current status of Audio-SpectraCLI.
+     - Run the command `Audio-SpectraCLI: View Status` from the Command Palette.
+     - You’ll see a notification indicating that Audio-SpectraCLI is ready to use.
+
+5. **Verify the Extension**
+   - Ensure that the Audio-SpectraCLI commands work as expected by following the steps above.
+   - You should see notifications for the status and sample code added in the editor.
+
+6. **Customize as Needed**
+   - You can modify the inserted code or use the extension as a reference for developing your own custom scripts with Audio-SpectraCLI.
+
+> **Note**: If you encounter issues, check the extension's [README](./README.md) or reach out to [email protected] support for troubleshooting.
+
+Enjoy using Audio-SpectraCLI in VS 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. Also, the user can modify (wrt [v4.1.0](https://github.com/AdityaSeth777/Audio-SpectraCLI/tree/4.1.0)) the Duration (in seconds), Sampling Rate (in Hz), and Block Size.
+
+---
+
+</details>
+
+----
+
+<details>
+
+<summary> Installation & Usage (Using PIP on Windows)</summary>
+
+1. Install using pip (Use pip3 instead, if pip doesn't work.)
+
+```
+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/main/tests/test.py) as a reference or use the following code :
+
+```python
+from Audio_SpectraCLI import AudioSpectrumVisualizer
+from PyQt5.QtWidgets import QApplication
+
+# Creating an instance of AudioSpectrumVisualizer with custom parameters
+app = QApplication([])
+audio_visualizer = AudioSpectrumVisualizer(
+    duration=5, fs=22050, block_size=1024, frequency_range=(1000, 5000), color='red')
+
+# Starting the audio spectrum visualization
+audio_visualizer.show()
+app.exec_()
 ```
 
-## Installation & Usage (Using PIP)
+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. Also, the user can modify (wrt [v4.1.0](https://github.com/AdityaSeth777/Audio-SpectraCLI/tree/4.1.0)) the Duration (in seconds), Sampling Rate (in Hz), and Block Size.
+
+---
 
-1. Install using pip
+</details>
+
+---
+
+<details>
+
+<summary> Installation & Usage (Using Homebrew and pip on MacOS)</summary>
+
+1. Install using pip (Use pip3 instead, if pip doesn't work.)
 
 ```
+brew install pyaudio
 pip install Audio-SpectraCLI
 ```
 
@@ -96,11 +210,18 @@ audio_visualizer.show()
 app.exec_()
 ```
 
-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. Also, the user can modify (wrt [v4.0](https://github.com/AdityaSeth777/Audio-SpectraCLI/tree/4.0)) the Duration (in seconds), Sampling Rate (in Hz), and Block Size.
+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. Also, the user can modify (wrt [v4.1.0](https://github.com/AdityaSeth777/Audio-SpectraCLI/tree/4.1.0)) the Duration (in seconds), Sampling Rate (in Hz), and Block Size.
+
+---
+
+</details>
+
 
 ---
 
-## Examining & Usage for fun :D (Using Docker)
+<details>
+
+<summary> Examining & Usage (Using Docker) </summary>
 
 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).
@@ -141,11 +262,17 @@ audio_visualizer.show()
 app.exec_()
 ```
 
-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. Also, the user can modify (wrt [v4.0](https://github.com/AdityaSeth777/Audio-SpectraCLI/tree/4.0)) the Duration (in seconds), Sampling Rate (in Hz), and Block Size.
+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. Also, the user can modify (wrt [v4.1.0](https://github.com/AdityaSeth777/Audio-SpectraCLI/tree/4.1.0)) the Duration (in seconds), Sampling Rate (in Hz), and Block Size.
+
+---
+
+</details>
 
 ---
 
-## Building the Docker Image Locally (for fun :D)
+<details>
+
+<summary> Building the Docker Image Locally </summary>
 
 If you prefer to build the Docker image locally, follow these steps:
 
@@ -191,7 +318,11 @@ audio_visualizer.show()
 app.exec_()
 ```
 
-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. Also, the user can modify (wrt [v4.0](https://github.com/AdityaSeth777/Audio-SpectraCLI/tree/4.0)) the Duration (in seconds), Sampling Rate (in Hz), and Block Size.
+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. Also, the user can modify (wrt [v4.1.0](https://github.com/AdityaSeth777/Audio-SpectraCLI/tree/4.1.0)) the Duration (in seconds), Sampling Rate (in Hz), and Block Size.
+
+</details>
+
+---
 
 ## Upcoming Features
 
@@ -225,4 +356,4 @@ Contact: [[email protected]](mailto:[email protected]?subject=Email%20ow
 
 ---
 
-# Made with <img width="40" height="40" src="https://img.icons8.com/clouds/100/love-circled.png" alt="love-circled"/> and <img width="40" height="40" src="https://img.icons8.com/clouds/100/python.png" alt="python"/>
+# Made with <img width="40" height="40" src="https://img.icons8.com/clouds/100/love-circled.png" alt="love-circled"/> and <img width="40" height="40" src="https://img.icons8.com/clouds/100/python.png" alt="python"/>

audiospectra-cli/.vscode-test.mjs

@@ -0,0 +1,6 @@
+import { defineConfig } from '@vscode/test-cli';
+
+export default defineConfig({
+	files: 'out/test/**/*.test.js',
+});
+

audiospectra-cli/.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+  // See http://go.microsoft.com/fwlink/?LinkId=827846
+  // for the documentation about the extensions.json format
+  "recommendations": ["dbaeumer.vscode-eslint", "connor4312.esbuild-problem-matchers", "ms-vscode.extension-test-runner"]
+}

audiospectra-cli/.vscode/launch.json

@@ -0,0 +1,18 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Run Extension",
+            "type": "extensionHost",
+            "request": "launch",
+            "runtimeExecutable": "${execPath}",
+            "args": [
+                "--extensionDevelopmentPath=${workspaceFolder}"
+            ],
+            "outFiles": [
+                "${workspaceFolder}/dist/**/*.js"
+            ],
+            "preLaunchTask": "npm: compile"
+        }
+    ]
+}

audiospectra-cli/.vscode/settings.json

@@ -0,0 +1,13 @@
+// Place your settings in this file to overwrite default and user settings.
+{
+    "files.exclude": {
+        "out": false, // set this to true to hide the "out" folder with the compiled JS files
+        "dist": false // set this to true to hide the "dist" folder with the compiled JS files
+    },
+    "search.exclude": {
+        "out": true, // set this to false to include "out" folder in search results
+        "dist": true // set this to false to include "dist" folder in search results
+    },
+    // Turn off tsc task auto detection since we have the necessary tasks as npm scripts
+    "typescript.tsc.autoDetect": "off"
+}

audiospectra-cli/.vscode/tasks.json

@@ -0,0 +1,64 @@
+// See https://go.microsoft.com/fwlink/?LinkId=733558
+// for the documentation about the tasks.json format
+{
+	"version": "2.0.0",
+	"tasks": [
+		{
+            "label": "watch",
+            "dependsOn": [
+                "npm: watch:tsc",
+                "npm: watch:esbuild"
+            ],
+            "presentation": {
+                "reveal": "never"
+            },
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            }
+        },
+        {
+            "type": "npm",
+            "script": "watch:esbuild",
+            "group": "build",
+            "problemMatcher": "$esbuild-watch",
+            "isBackground": true,
+            "label": "npm: watch:esbuild",
+            "presentation": {
+                "group": "watch",
+                "reveal": "never"
+            }
+        },
+		{
+            "type": "npm",
+            "script": "watch:tsc",
+            "group": "build",
+            "problemMatcher": "$tsc-watch",
+            "isBackground": true,
+            "label": "npm: watch:tsc",
+            "presentation": {
+                "group": "watch",
+                "reveal": "never"
+            }
+        },
+		{
+			"type": "npm",
+			"script": "watch-tests",
+			"problemMatcher": "$tsc-watch",
+			"isBackground": true,
+			"presentation": {
+				"reveal": "never",
+				"group": "watchers"
+			},
+			"group": "build"
+		},
+		{
+			"label": "tasks: watch-tests",
+			"dependsOn": [
+				"npm: watch",
+				"npm: watch-tests"
+			],
+			"problemMatcher": []
+		}
+	]
+}

audiospectra-cli/.vscodeignore

@@ -0,0 +1,14 @@
+.vscode/**
+.vscode-test/**
+out/**
+node_modules/**
+src/**
+.gitignore
+.yarnrc
+esbuild.js
+vsc-extension-quickstart.md
+**/tsconfig.json
+**/eslint.config.mjs
+**/*.map
+**/*.ts
+**/.vscode-test.*