modusa 0.1.0__tar.gz → 0.2.0__tar.gz

{modusa-0.1.0 → modusa-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: modusa
-Version: 0.1.0
+Version: 0.2.0
 Summary: A modular signal analysis python library.
 Author-Email: Ankit Anand <ankit0.anand0@gmail.com>
 License: MIT
@@ -24,24 +24,29 @@ Requires-Dist: snakeviz>=2.2.2
 Requires-Dist: line-profiler>=4.2.0
 Requires-Dist: nbsphinx==0.9.7
 Requires-Dist: ghp-import>=2.1.0
+Requires-Dist: yt-dlp>=2025.6.30
+Requires-Dist: sphinx-book-theme>=1.1.4
+Requires-Dist: pydata-sphinx-theme>=0.15.4
+Requires-Dist: sphinx-material>=0.0.36
 Description-Content-Type: text/markdown
 
 # modusa
 
-**modusa**: **Mod**ular **U**nified **S**ignal **A**rchitecture* is a flexible, extensible Python framework for building, transforming, and analyzing different signal representations. It is a domain-agnostic core architecture for modern signal processing workflows.
+[**modusa**](https://meluron-toolbox.github.io/modusa/) is a modular framework for audio signal analysis and processing, designed to help audio researchers and developers build DSP chains with minimal code.
 
 ---
 
-## 🔧 Features
+## Core Components
 
 - ⚙️ **modusa Signals**
 - 🧩 **modusa Plugins**
 - 📊 **modusa Genetators**
-- ♻️ **modusa Engine**
+- 📥 **modusa I/O**
+- ♻️ **modusa Engines**
 
 ---
 
-## 🚀 Installation
+## Installation
 
 > modusa is under active development. You can install the latest version via:
 
@@ -53,7 +58,7 @@ pdm install
 
 ---
 
-## 🧪 Tests
+## Tests
 
 ```bash
 pytest tests/
@@ -61,26 +66,26 @@ pytest tests/
 
 ---
 
-## 🧊 Status
+## Status
 
 modusa is in **early alpha**. Expect rapid iteration, breaking changes, and big ideas.  
 If you like the direction, consider ⭐ starring the repo and opening issues or ideas.
 
 ---
 
-## 🧠 About
+## About
 
 **modusa** is developed and maintained by [meluron](https://www.github.com/meluron),
 
 ---
 
-## 📜 License
+## License
 
 MIT License. See `LICENSE` for details.
 
 ---
 
-## 🙌 Contributions
+## Contributions
 
 Pull requests, ideas, and discussions are welcome!  
 No matter which domain you are in, if you work with any signal, we'd love your input.

{modusa-0.1.0 → modusa-0.2.0}/README.md

@@ -1,19 +1,20 @@
 # modusa
 
-**modusa**: **Mod**ular **U**nified **S**ignal **A**rchitecture* is a flexible, extensible Python framework for building, transforming, and analyzing different signal representations. It is a domain-agnostic core architecture for modern signal processing workflows.
+[**modusa**](https://meluron-toolbox.github.io/modusa/) is a modular framework for audio signal analysis and processing, designed to help audio researchers and developers build DSP chains with minimal code.
 
 ---
 
-## 🔧 Features
+## Core Components
 
 - ⚙️ **modusa Signals**
 - 🧩 **modusa Plugins**
 - 📊 **modusa Genetators**
-- ♻️ **modusa Engine**
+- 📥 **modusa I/O**
+- ♻️ **modusa Engines**
 
 ---
 
-## 🚀 Installation
+## Installation
 
 > modusa is under active development. You can install the latest version via:
 
@@ -25,7 +26,7 @@ pdm install
 
 ---
 
-## 🧪 Tests
+## Tests
 
 ```bash
 pytest tests/
@@ -33,26 +34,26 @@ pytest tests/
 
 ---
 
-## 🧊 Status
+## Status
 
 modusa is in **early alpha**. Expect rapid iteration, breaking changes, and big ideas.  
 If you like the direction, consider ⭐ starring the repo and opening issues or ideas.
 
 ---
 
-## 🧠 About
+## About
 
 **modusa** is developed and maintained by [meluron](https://www.github.com/meluron),
 
 ---
 
-## 📜 License
+## License
 
 MIT License. See `LICENSE` for details.
 
 ---
 
-## 🙌 Contributions
+## Contributions
 
 Pull requests, ideas, and discussions are welcome!  
 No matter which domain you are in, if you work with any signal, we'd love your input.

{modusa-0.1.0 → modusa-0.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "modusa"
-version = "0.1.0"
+version = "0.2.0"
 description = "A modular signal analysis python library."
 authors = [
     { name = "Ankit Anand", email = "ankit0.anand0@gmail.com" },
@@ -25,6 +25,10 @@ dependencies = [
     "line-profiler>=4.2.0",
     "nbsphinx==0.9.7",
     "ghp-import>=2.1.0",
+    "yt-dlp>=2025.6.30",
+    "sphinx-book-theme>=1.1.4",
+    "pydata-sphinx-theme>=0.15.4",
+    "sphinx-material>=0.0.36",
 ]
 requires-python = ">=3.12"
 readme = "README.md"

{modusa-0.1.0 → modusa-0.2.0}/src/modusa/decorators.py

@@ -103,7 +103,7 @@ def validate_arg(arg_name: str, value: Any, expected_type: Any) -> None:
 		union_args = get_args(expected_type)
 		for typ in union_args:
 			typ_origin = get_origin(typ) or typ
-			if type(value) is typ_origin:
+			if isinstance(value, typ_origin):
 				return
 		
 		# ❌ If none match
@@ -116,17 +116,17 @@ def validate_arg(arg_name: str, value: Any, expected_type: Any) -> None:
 	
 	# Handle generic types like list[float], tuple[int, str]
 	elif origin is not None:
-		if type(value) is not origin:
+		if not isinstance(value, origin):
 			raise excp.ValidationError(
-				f"Argument '{arg_name}' must be exactly of type {origin.__name__}, got {type(value).__name__}"
+				f"Argument '{arg_name}' must be of type {origin.__name__}, got {type(value).__name__}"
 			)
 		return
 		
 	# ✅ Handle plain types
 	elif isinstance(expected_type, type):
-		if type(value) is not expected_type:
+		if not isinstance(value, expected_type):
 			raise excp.ValidationError(
-				f"Argument '{arg_name}' must be exactly {expected_type.__name__}, got {type(value).__name__}"
+				f"Argument '{arg_name}' must be of type {expected_type.__name__}, got {type(value).__name__}"
 			)
 		return
 	# ❌ Unsupported type structure

modusa-0.2.0/src/modusa/devtools/generate_template.py

@@ -0,0 +1,144 @@
+#!/usr/bin/env python3
+
+from datetime import date
+from pathlib import Path
+import questionary
+import sys
+
+ROOT_DIR = Path(__file__).parents[3].resolve()
+SRC_CODE_DIR = ROOT_DIR / "src/modusa"
+TESTS_DIR = ROOT_DIR / "tests"
+TEMPLATES_DIR = ROOT_DIR / "src/modusa/devtools/templates"
+
+PLUGIN_INFO = {
+	"template_fp": TEMPLATES_DIR / "plugin.py",
+	"test_template_fp": TEMPLATES_DIR / "test.py",
+	"template_dump_dp": SRC_CODE_DIR / "plugins",
+	"test_template_dump_dp": TESTS_DIR / "test_plugins"
+}
+IO_INFO = {
+	"template_fp": TEMPLATES_DIR / "io.py",
+	"test_template_fp": TEMPLATES_DIR / "test.py",
+	"template_dump_dp": SRC_CODE_DIR / "io",
+	"test_template_dump_dp": TESTS_DIR / "test_io"
+}
+GENERATOR_INFO = {
+	"template_fp": TEMPLATES_DIR / "generator.py",
+	"test_template_fp": TEMPLATES_DIR / "test.py",
+	"template_dump_dp": SRC_CODE_DIR / "generators",
+	"test_template_dump_dp": TESTS_DIR / "test_generators"
+}
+SIGNAL_INFO = {
+	"template_fp": TEMPLATES_DIR / "signal.py",
+	"test_template_fp": TEMPLATES_DIR / "test.py",
+	"template_dump_dp": SRC_CODE_DIR / "signals",
+	"test_template_dump_dp": TESTS_DIR / "test_signals"
+}
+ENGINE_INFO = {
+	"template_fp": TEMPLATES_DIR / "engine.py",
+	"test_template_fp": TEMPLATES_DIR / "test.py",
+	"template_dump_dp": SRC_CODE_DIR / "engines",
+	"test_template_dump_dp": TESTS_DIR / "test_engines"
+}
+
+
+class TemplateGenerator():
+	"""
+	Generates template for `plugin`, `engine`, `signal`, `generator` along with its corresponding `test` file
+	in the `tests` directory.
+	"""
+	
+	
+	@staticmethod
+	def get_path_info(for_what: str):
+		if for_what == "plugin": return PLUGIN_INFO
+		if for_what == "io": return IO_INFO
+		if for_what == "signal": return SIGNAL_INFO
+		if for_what == "engine": return ENGINE_INFO
+		if for_what == "generator": return GENERATOR_INFO
+	
+	@staticmethod
+	def ask_questions(for_what: str, path_info: dict) -> dict:
+		"""Asks question about the template to be generated."""
+		print("----------------------")
+		print(for_what.upper())
+		print("----------------------")
+		module_name = questionary.text("Module name (snake_case): ").ask()
+		
+		if module_name is None:
+			sys.exit(1)
+			
+		if not module_name.endswith(".py"): # Adding extension
+			module_name = module_name + ".py"
+		# Checking if the module name already exists in the dump directory
+		if (path_info["template_dump_dp"] / module_name).exists():
+			print(f"⚠️ File already exists, choose another name.")
+			sys.exit(1)
+		
+		class_name = questionary.text(f"Class name (CamelCase{for_what.capitalize()}): ").ask()
+		if class_name is None:
+			sys.exit(1)
+			
+		author_name = questionary.text("Author name: ").ask()
+		if author_name is None:
+			sys.exit(1)
+		
+		author_email = questionary.text("Author email: ").ask()
+		if author_email is None:
+			sys.exit(1)
+		
+		answers = {"for_what": for_what, "module_name": module_name, "class_name": class_name, "author_name": author_name, "author_email": author_email, "date_created": date.today()}
+			
+		return answers
+	
+	@staticmethod
+	def load_template_file(template_fp: Path) -> str:
+		"""Loads template file."""
+		if not template_fp.exists():
+			print(f"❌ Template not found: {template_fp}")
+			sys.exit(1)
+		
+		template_code = template_fp.read_text()
+		
+		return template_code
+	
+	@staticmethod
+	def fill_placeholders(template_code: str, placehoders_dict: dict) -> str:
+		"""Fills placeholder in the template with the user input from CLI."""
+		template_code = template_code.format(**placehoders_dict)  # Fill placeholders
+		return template_code
+	
+	@staticmethod
+	def save_file(content: str, output_path: Path) -> None:
+		"""Saves file in the correct directory with the right tempalate content."""
+		output_path.parent.mkdir(parents=True, exist_ok=True)
+		output_path.write_text(content)
+		
+		# Generating a corresponding test file too
+		what_for = output_path.parent.name # plugins, generators, ...
+		module_name = output_path.name # this.py
+	
+	
+	@staticmethod
+	def create_template(for_what: str) -> None:
+		
+		# Load correct path location info for the templates and where to dump the files
+		path_info: dict = TemplateGenerator.get_path_info(for_what)
+		
+		# Ask basic questions to create the template for `plugin`, `generator`, ...
+		answers: dict = TemplateGenerator.ask_questions(for_what, path_info)
+		
+		# Load the correct template file and test file
+		template_code: str = TemplateGenerator.load_template_file(template_fp=path_info['template_fp'])
+		test_code: str = TemplateGenerator.load_template_file(template_fp=path_info['test_template_fp'])
+		
+		# Update the dynamic values based on the answers
+		template_code: str = TemplateGenerator.fill_placeholders(template_code, answers)
+		test_code: str = TemplateGenerator.fill_placeholders(test_code, answers)
+		
+		# Save it to a file and put it in the correct folder
+		TemplateGenerator.save_file(content=template_code, output_path=path_info['template_dump_dp'] / answers['module_name'])
+		TemplateGenerator.save_file(content=test_code, output_path=path_info['test_template_dump_dp'] / answers['module_name'])
+		
+		print(f"✅ {for_what}:", "open " + str(path_info['template_dump_dp'] / answers['module_name']))
+		print(f"✅ test:", "open " + str(path_info['test_template_dump_dp'] / answers['module_name']))

{modusa-0.1.0 → modusa-0.2.0}/src/modusa/devtools/main.py

@@ -20,10 +20,12 @@ def main():
 		create_parser = subparsers.add_parser("create", help="Create new Modusa components")
 		create_subparsers = create_parser.add_subparsers(dest="what", required=True)
 		
-		create_subparsers.add_parser("engine", help="Create a new engine class").set_defaults(func=lambda:TemplateGenerator.create_template("engines"))
-		create_subparsers.add_parser("plugin", help="Create a new plugin class").set_defaults(func=lambda:TemplateGenerator.create_template("plugins"))
-		create_subparsers.add_parser("signal", help="Create a new signal class").set_defaults(func=lambda:TemplateGenerator.create_template("signals"))
-		create_subparsers.add_parser("generator", help="Create a new signal generator class").set_defaults(func=lambda:TemplateGenerator.create_template("generators"))
+		create_subparsers.add_parser("engine", help="Create a new engine class").set_defaults(func=lambda:TemplateGenerator.create_template("engine"))
+		create_subparsers.add_parser("plugin", help="Create a new plugin class").set_defaults(func=lambda:TemplateGenerator.create_template("plugin"))
+		create_subparsers.add_parser("signal", help="Create a new signal class").set_defaults(func=lambda:TemplateGenerator.create_template("signal"))
+		create_subparsers.add_parser("generator", help="Create a new signal generator class").set_defaults(func=lambda:TemplateGenerator.create_template("generator"))
+		create_subparsers.add_parser("io", help="Create a new IO class").set_defaults(func=lambda:TemplateGenerator.create_template("io"))
+		
 		
 		# --- LIST group ---
 		list_parser = subparsers.add_parser("list", help="List information about Modusa components")

modusa-0.1.0/src/modusa/devtools/templates/engines.py → modusa-0.2.0/src/modusa/devtools/templates/engine.py

@@ -3,20 +3,21 @@
 
 from modusa import excp
 from modusa.decorators import validate_args_type
-from modusa.engines.base import ModusaEngine
+from modusa.engines import ModusaEngine
 from typing import Any
 
+
 class {class_name}(ModusaEngine):
 	"""
-
+	
 	"""
 	
 	#--------Meta Information----------
-	name = ""
-	description = ""
-	author_name = "{author_name}"
-	author_email = "{author_email}"
-	created_at = "{date_created}"
+	_name = ""
+	_description = ""
+	_author_name = "{author_name}"
+	_author_email = "{author_email}"
+	_created_at = "{date_created}"
 	#----------------------------------
 	
 	def __init__(self):

modusa-0.1.0/src/modusa/devtools/templates/generators.py → modusa-0.2.0/src/modusa/devtools/templates/generator.py

@@ -1,8 +1,9 @@
 #!/usr/bin/env python3
 
 
+from modusa import excp
 from modusa.decorators import validate_args_type
-from modusa.generators.base import ModusaGenerator
+from modusa.generators import ModusaGenerator
 
 
 class {class_name}(ModusaGenerator):
@@ -11,16 +12,13 @@ class {class_name}(ModusaGenerator):
 	"""
 	
 	#--------Meta Information----------
-	name = ""
-	description = ""
-	author_name = "{author_name}"
-	author_email = "{author_email}"
-	created_at = "{date_created}"
+	_name = ""
+	_description = ""
+	_author_name = "{author_name}"
+	_author_email = "{author_email}"
+	_created_at = "{date_created}"
 	#----------------------------------
 	
 	def __init__(self):
 		super().__init__()
-	
-	
-	def generate(self) -> Any:
-		pass
+	

modusa-0.2.0/src/modusa/devtools/templates/io.py

@@ -0,0 +1,24 @@
+#!/usr/bin/env python3
+
+
+from modusa import excp
+from modusa.decorators import validate_args_type
+from modusa.io import ModusaIO
+
+
+class {class_name}(ModusaIO):
+	"""
+
+	"""
+	
+	#--------Meta Information----------
+	_name = ""
+	_description = ""
+	_author_name = "{author_name}"
+	_author_email = "{author_email}"
+	_created_at = "{date_created}"
+	#----------------------------------
+	
+	
+
+	

modusa-0.1.0/src/modusa/devtools/templates/plugins.py → modusa-0.2.0/src/modusa/devtools/templates/plugin.py

@@ -1,8 +1,9 @@
 #!/usr/bin/env python3
 
 
-from modusa.plugins.base import ModusaPlugin
+from modusa import excp
 from modusa.decorators import immutable_property, validate_args_type, plugin_safety_check
+from modusa.plugins import ModusaPlugin
 
 
 class {class_name}(ModusaPlugin):
@@ -11,11 +12,11 @@ class {class_name}(ModusaPlugin):
 	"""
 	
 	#--------Meta Information----------
-	name = ""
-	description = ""
-	author_name = "{author_name}"
-	author_email = "{author_email}"
-	created_at = "{date_created}"
+	_name = ""
+	_description = ""
+	_author_name = "{author_name}"
+	_author_email = "{author_email}"
+	_created_at = "{date_created}"
 	#----------------------------------
 	
 	def __init__(self):

modusa-0.2.0/src/modusa/devtools/templates/signal.py

@@ -0,0 +1,40 @@
+#!/usr/bin/env python3
+
+
+from modusa import excp
+from modusa.decorators import immutable_property, validate_args_type
+from modusa.signals.base import ModusaSignal
+from typing import Self, Any
+import numpy as np
+
+class {class_name}(ModusaSignal):
+	"""
+
+	"""
+	
+	#--------Meta Information----------
+	_name = ""
+	_description = ""
+	_author_name = "{author_name}"
+	_author_email = "{author_email}"
+	_created_at = "{date_created}"
+	#----------------------------------
+	
+	@validate_args_type()
+	def __init__(self):
+		super().__init__() # Instantiating `ModusaSignal` class
+	
+		self.title = "" # This title will be used as plot title by default
+		
+	#----------------------
+	# Properties
+	#----------------------
+		
+	
+	
+	
+	
+	
+	#----------------------
+	# Tools
+	#----------------------

modusa-0.2.0/src/modusa/devtools/templates/test.py

@@ -0,0 +1,11 @@
+#!/usr/bin/env python3
+
+
+#--------Meta Information----------
+_class_name = "{class_name}"
+_author_name = "{author_name}"
+_author_email = "{author_email}"
+_created_at = "{date_created}"
+#----------------------------------
+	
+from modusa.{for_what}s import {class_name}

modusa-0.2.0/src/modusa/engines/__init__.py

@@ -0,0 +1,3 @@
+#!/usr/bin/env python3
+
+from .base import ModusaEngine

modusa-0.2.0/src/modusa/generators/__init__.py

@@ -0,0 +1,5 @@
+#!/usr/bin/env python3
+
+from .base import ModusaGenerator
+
+from .audio_waveforms import AudioWaveformGenerator