freyja 0.0.0__tar.gz

freyja-0.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2019] [Tangled Path]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

freyja-0.0.0/PKG-INFO

@@ -0,0 +1,332 @@
+Metadata-Version: 2.1
+Name: freyja
+Version: 0.0.0
+Summary: Python Library that builds a complete CLI given one or more functions using introspection
+Home-page: https://pypi.org/project/freyja/
+License: MIT
+Keywords: cli,auto,introspection,argparse,command-line
+Author: Steven Miers
+Author-email: steven.miers@gmail.com
+Requires-Python: >=3.13.7,<4.0.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Systems Administration
+Classifier: Topic :: Utilities
+Project-URL: Documentation, https://github.com/tangledpath/freyja/docs
+Project-URL: Repository, https://github.com/tangledpath/freyja
+Description-Content-Type: text/markdown
+
+![Freyja](freyja.png)
+
+# Freyja ⚡
+**No-dependency, zero-configuration CLI tool to build command-line interfaces purely from your code.**
+
+Transform your Python functions and classes into powerful command-line applications in seconds! Freyja uses introspection and type annotations to automatically generate professional CLIs with zero configuration required.
+
+## Table of Contents
+* [🚀 Why Freyja?](#-why-freyja)
+* [⚡ Quick Start](#-quick-start)
+* [🗂️ Module-based CLI](#️-module-based-cli)
+* [🏗️ Class-based CLI](#️-class-based-cli)
+  * [Direct Methods Pattern](#direct-methods-pattern)
+  * [Inner Classes Pattern](#inner-classes-pattern)
+* [✨ Key Features](#-key-features)
+* [📚 Documentation](#-documentation)
+* [🛠️ Development](#️-development)
+* [⚙️ Requirements](#️-requirements)
+
+## 🚀 Why Freyja?
+
+**Build CLIs in under 5 minutes!** No configuration files, no complex setup, no learning curve. Just add type annotations to your functions and Freyja does the rest.
+
+```bash
+pip install freyja
+# That's it! No dependencies, no configuration needed.
+```
+
+**Before Freyja:**
+```bash
+python script.py --config-file /path/to/config --database-host localhost --database-port 5432 --username admin --password secret --table-name users --action create --data '{"name": "Alice", "email": "alice@example.com"}'
+```
+
+**After Freyja:**
+```bash
+python script.py database--create-user --name Alice --email alice@example.com
+# Global config handled automatically, clean syntax, built-in help
+```
+
+## ⚡ Quick Start
+
+**Step 1:** Install Freyja
+```bash
+pip install freyja
+```
+
+**Step 2:** Add type annotations to your functions
+```python
+def greet(name: str = "World", excited: bool = False) -> None:
+    """Greet someone by name."""
+    greeting = f"Hello, {name}!"
+    if excited:
+        greeting += " 🎉"
+    print(greeting)
+```
+
+**Step 3:** Add 3 lines of Freyja code
+```python
+from freyja import CLI
+import sys
+
+if __name__ == '__main__':
+    cli = CLI(sys.modules[__name__], title="My CLI")
+    cli.display()
+```
+
+**Step 4:** Use your new CLI!
+```bash
+python script.py greet --name Alice --excited
+# Output: Hello, Alice! 🎉
+
+python script.py --help
+# Automatic help generation with beautiful formatting
+```
+
+## 🗂️ Module-based CLI
+
+Perfect for functional programming styles and simple utilities. Every function becomes a command:
+
+```python
+# data_processor.py
+from freyja import CLI
+import sys
+
+
+def process_csv(input_file: str, output_format: str = "json", verbose: bool = False) -> None:
+    """Process CSV file and convert to specified format."""
+    print(f"Processing {input_file} -> {output_format}")
+    if verbose:
+        print("Verbose mode enabled")
+
+
+def analyze_logs(log_file: str, pattern: str, max_lines: int = 1000) -> None:
+    """Analyze log files for specific patterns."""
+    print(f"Analyzing {log_file} for pattern: {pattern} (max {max_lines} lines)")
+
+
+if __name__ == '__main__':
+    cli = CLI(sys.modules[__name__], title="Data Processing Tools")
+    cli.display()
+```
+
+**Usage:**
+```bash
+python data_processor.py process-csv --input-file data.csv --output-format xml --verbose
+python data_processor.py analyze-logs --log-file app.log --pattern "ERROR" --max-lines 500
+python data_processor.py --help  # Beautiful auto-generated help
+```
+
+## 🏗️ Class-based CLI
+
+Ideal for stateful applications and complex workflows. Supports two powerful patterns:
+
+### Direct Methods Pattern
+
+Simple and clean - each method becomes a command:
+
+```python
+# calculator.py
+from freyja import CLI
+
+
+class Calculator:
+    """Advanced calculator with memory and history."""
+
+    def __init__(self, precision: int = 2, memory_enabled: bool = True):
+        """Initialize calculator with global settings."""
+        self.precision = precision
+        self.memory = 0 if memory_enabled else None
+
+    def add(self, a: float, b: float, store_result: bool = False) -> None:
+        """Add two numbers together."""
+        result = round(a + b, self.precision)
+        print(f"{a} + {b} = {result}")
+        
+        if store_result and self.memory is not None:
+            self.memory = result
+            print(f"Result stored in memory: {result}")
+
+    def multiply(self, a: float, b: float) -> None:
+        """Multiply two numbers."""
+        result = round(a * b, self.precision)
+        print(f"{a} × {b} = {result}")
+
+
+if __name__ == '__main__':
+    cli = CLI(Calculator, title="Advanced Calculator")
+    cli.display()
+```
+
+**Usage:**
+```bash
+python calculator.py --precision 4 add --a 3.14159 --b 2.71828 --store-result
+# Output: 3.14159 + 2.71828 = 5.8599
+#         Result stored in memory: 5.8599
+```
+
+### Inner Classes Pattern
+
+Organize complex applications with flat double-dash commands:
+
+```python
+# project_manager.py
+from freyja import CLI
+from pathlib import Path
+
+
+class ProjectManager:
+    """Complete project management suite with organized command structure."""
+
+    def __init__(self, config_file: str = "config.json", debug: bool = False):
+        """Initialize with global settings."""
+        self.config_file = config_file
+        self.debug = debug
+
+    class Database:
+        """Database operations and management."""
+
+        def __init__(self, connection_string: str = "sqlite:///projects.db", timeout: int = 30):
+            """Initialize database connection."""
+            self.connection_string = connection_string
+            self.timeout = timeout
+
+        def migrate(self, version: str = "latest", dry_run: bool = False) -> None:
+            """Run database migrations."""
+            action = "Would run" if dry_run else "Running"
+            print(f"{action} migration to version: {version}")
+            print(f"Connection: {self.connection_string}")
+
+        def backup(self, output_path: Path, compress: bool = True) -> None:
+            """Create database backup."""
+            compression = "compressed" if compress else "uncompressed"
+            print(f"Creating {compression} backup at: {output_path}")
+
+    class Projects:
+        """Project creation and management operations."""
+
+        def __init__(self, workspace: str = "./projects", auto_save: bool = True):
+            """Initialize project operations."""
+            self.workspace = workspace
+            self.auto_save = auto_save
+
+        def create(self, name: str, template: str = "basic", description: str = "") -> None:
+            """Create a new project from template."""
+            print(f"Creating project '{name}' using '{template}' template")
+            print(f"Workspace: {self.workspace}")
+            print(f"Description: {description}")
+            print(f"Auto-save: {'enabled' if self.auto_save else 'disabled'}")
+
+        def deploy(self, project_name: str, environment: str = "staging", force: bool = False) -> None:
+            """Deploy project to specified environment."""
+            action = "Force deploying" if force else "Deploying"
+            print(f"{action} {project_name} to {environment}")
+
+
+if __name__ == '__main__':
+    cli = CLI(ProjectManager, title="Project Management Suite")
+    cli.display()
+```
+
+**Usage:**
+```bash
+# Global + Sub-global + Command arguments (all flat)
+python project_manager.py --config-file prod.json --debug \
+  database--migrate --connection-string postgres://prod --version 2.1.0 --dry-run
+
+# Create new project with custom workspace
+python project_manager.py projects--create --workspace /prod/projects --auto-save \
+  --name "web-app" --template "react" --description "Production web application"
+
+# Deploy with force flag
+python project_manager.py projects--deploy --project-name web-app --environment production --force
+
+# Beautiful help shows all flat commands organized by group
+python project_manager.py --help
+```
+
+## ✨ Key Features
+
+🚀 **Zero Configuration** - Works out of the box with just type annotations  
+⚡ **Lightning Fast** - No runtime dependencies, minimal overhead  
+🎯 **Type Safe** - Automatic validation from your type hints  
+📚 **Auto Documentation** - Help text generated from your docstrings  
+🎨 **Beautiful Output** - Professional themes and formatting  
+🔧 **Flexible Architecture** - Module-based or class-based patterns  
+📦 **No Dependencies** - Uses only Python standard library  
+🌈 **Shell Completion** - Bash, Zsh, Fish, and PowerShell support  
+✅ **Production Ready** - Battle-tested in enterprise applications  
+
+## 📚 Documentation
+
+**[📖 Complete Documentation Hub](docs/README.md)** - Everything you need to master Freyja
+
+### Quick Links
+* **[🚀 Getting Started](docs/getting-started/README.md)** - Installation and first steps
+* **[👤 User Guide](docs/user-guide/README.md)** - Comprehensive guides for both CLI modes  
+* **[⚙️ Features](docs/features/README.md)** - Type annotations, themes, completion, and more
+* **[📋 Examples & Best Practices](docs/guides/README.md)** - Real-world examples and patterns
+* **[❓ FAQ](docs/faq.md)** - Frequently asked questions
+* **[🔧 API Reference](docs/reference/README.md)** - Complete API documentation
+
+## 🛠️ Development
+
+**[📖 Development Guide](CLAUDE.md)** - Comprehensive guide for contributors
+
+### Quick Setup
+
+```bash
+# Clone and setup
+git clone https://github.com/tangledpath/freyja.git
+cd freyja
+
+# Install Poetry and setup environment  
+curl -sSL https://install.python-poetry.org | python3 -
+./bin/setup-dev.sh
+
+# Run tests and examples
+./bin/test.sh
+poetry run python examples/mod_example.py --help
+poetry run python examples/cls_example.py --help
+```
+
+### Development Commands
+
+```bash
+poetry install              # Install dependencies
+./bin/test.sh              # Run tests with coverage
+./bin/lint.sh              # Run all linters and formatters
+poetry build               # Build package
+./bin/publish.sh           # Publish to PyPI (maintainers)
+```
+
+## ⚙️ Requirements
+
+* **Python 3.13.5+** (recommended) or Python 3.8+
+* **Zero runtime dependencies** - uses only Python standard library
+* **Type annotations required** - for automatic CLI generation
+* **Docstrings recommended** - for automatic help text generation
+
+---
+
+**Ready to transform your Python code into powerful CLIs?**
+
+```bash
+pip install freyja
+# Start building amazing command-line tools in minutes! ⚡
+```
+
+**[📚 Get Started Now →](docs/getting-started/README.md)**

freyja-0.0.0/README.md

@@ -0,0 +1,309 @@
+![Freyja](freyja.png)
+
+# Freyja ⚡
+**No-dependency, zero-configuration CLI tool to build command-line interfaces purely from your code.**
+
+Transform your Python functions and classes into powerful command-line applications in seconds! Freyja uses introspection and type annotations to automatically generate professional CLIs with zero configuration required.
+
+## Table of Contents
+* [🚀 Why Freyja?](#-why-freyja)
+* [⚡ Quick Start](#-quick-start)
+* [🗂️ Module-based CLI](#️-module-based-cli)
+* [🏗️ Class-based CLI](#️-class-based-cli)
+  * [Direct Methods Pattern](#direct-methods-pattern)
+  * [Inner Classes Pattern](#inner-classes-pattern)
+* [✨ Key Features](#-key-features)
+* [📚 Documentation](#-documentation)
+* [🛠️ Development](#️-development)
+* [⚙️ Requirements](#️-requirements)
+
+## 🚀 Why Freyja?
+
+**Build CLIs in under 5 minutes!** No configuration files, no complex setup, no learning curve. Just add type annotations to your functions and Freyja does the rest.
+
+```bash
+pip install freyja
+# That's it! No dependencies, no configuration needed.
+```
+
+**Before Freyja:**
+```bash
+python script.py --config-file /path/to/config --database-host localhost --database-port 5432 --username admin --password secret --table-name users --action create --data '{"name": "Alice", "email": "alice@example.com"}'
+```
+
+**After Freyja:**
+```bash
+python script.py database--create-user --name Alice --email alice@example.com
+# Global config handled automatically, clean syntax, built-in help
+```
+
+## ⚡ Quick Start
+
+**Step 1:** Install Freyja
+```bash
+pip install freyja
+```
+
+**Step 2:** Add type annotations to your functions
+```python
+def greet(name: str = "World", excited: bool = False) -> None:
+    """Greet someone by name."""
+    greeting = f"Hello, {name}!"
+    if excited:
+        greeting += " 🎉"
+    print(greeting)
+```
+
+**Step 3:** Add 3 lines of Freyja code
+```python
+from freyja import CLI
+import sys
+
+if __name__ == '__main__':
+    cli = CLI(sys.modules[__name__], title="My CLI")
+    cli.display()
+```
+
+**Step 4:** Use your new CLI!
+```bash
+python script.py greet --name Alice --excited
+# Output: Hello, Alice! 🎉
+
+python script.py --help
+# Automatic help generation with beautiful formatting
+```
+
+## 🗂️ Module-based CLI
+
+Perfect for functional programming styles and simple utilities. Every function becomes a command:
+
+```python
+# data_processor.py
+from freyja import CLI
+import sys
+
+
+def process_csv(input_file: str, output_format: str = "json", verbose: bool = False) -> None:
+    """Process CSV file and convert to specified format."""
+    print(f"Processing {input_file} -> {output_format}")
+    if verbose:
+        print("Verbose mode enabled")
+
+
+def analyze_logs(log_file: str, pattern: str, max_lines: int = 1000) -> None:
+    """Analyze log files for specific patterns."""
+    print(f"Analyzing {log_file} for pattern: {pattern} (max {max_lines} lines)")
+
+
+if __name__ == '__main__':
+    cli = CLI(sys.modules[__name__], title="Data Processing Tools")
+    cli.display()
+```
+
+**Usage:**
+```bash
+python data_processor.py process-csv --input-file data.csv --output-format xml --verbose
+python data_processor.py analyze-logs --log-file app.log --pattern "ERROR" --max-lines 500
+python data_processor.py --help  # Beautiful auto-generated help
+```
+
+## 🏗️ Class-based CLI
+
+Ideal for stateful applications and complex workflows. Supports two powerful patterns:
+
+### Direct Methods Pattern
+
+Simple and clean - each method becomes a command:
+
+```python
+# calculator.py
+from freyja import CLI
+
+
+class Calculator:
+    """Advanced calculator with memory and history."""
+
+    def __init__(self, precision: int = 2, memory_enabled: bool = True):
+        """Initialize calculator with global settings."""
+        self.precision = precision
+        self.memory = 0 if memory_enabled else None
+
+    def add(self, a: float, b: float, store_result: bool = False) -> None:
+        """Add two numbers together."""
+        result = round(a + b, self.precision)
+        print(f"{a} + {b} = {result}")
+        
+        if store_result and self.memory is not None:
+            self.memory = result
+            print(f"Result stored in memory: {result}")
+
+    def multiply(self, a: float, b: float) -> None:
+        """Multiply two numbers."""
+        result = round(a * b, self.precision)
+        print(f"{a} × {b} = {result}")
+
+
+if __name__ == '__main__':
+    cli = CLI(Calculator, title="Advanced Calculator")
+    cli.display()
+```
+
+**Usage:**
+```bash
+python calculator.py --precision 4 add --a 3.14159 --b 2.71828 --store-result
+# Output: 3.14159 + 2.71828 = 5.8599
+#         Result stored in memory: 5.8599
+```
+
+### Inner Classes Pattern
+
+Organize complex applications with flat double-dash commands:
+
+```python
+# project_manager.py
+from freyja import CLI
+from pathlib import Path
+
+
+class ProjectManager:
+    """Complete project management suite with organized command structure."""
+
+    def __init__(self, config_file: str = "config.json", debug: bool = False):
+        """Initialize with global settings."""
+        self.config_file = config_file
+        self.debug = debug
+
+    class Database:
+        """Database operations and management."""
+
+        def __init__(self, connection_string: str = "sqlite:///projects.db", timeout: int = 30):
+            """Initialize database connection."""
+            self.connection_string = connection_string
+            self.timeout = timeout
+
+        def migrate(self, version: str = "latest", dry_run: bool = False) -> None:
+            """Run database migrations."""
+            action = "Would run" if dry_run else "Running"
+            print(f"{action} migration to version: {version}")
+            print(f"Connection: {self.connection_string}")
+
+        def backup(self, output_path: Path, compress: bool = True) -> None:
+            """Create database backup."""
+            compression = "compressed" if compress else "uncompressed"
+            print(f"Creating {compression} backup at: {output_path}")
+
+    class Projects:
+        """Project creation and management operations."""
+
+        def __init__(self, workspace: str = "./projects", auto_save: bool = True):
+            """Initialize project operations."""
+            self.workspace = workspace
+            self.auto_save = auto_save
+
+        def create(self, name: str, template: str = "basic", description: str = "") -> None:
+            """Create a new project from template."""
+            print(f"Creating project '{name}' using '{template}' template")
+            print(f"Workspace: {self.workspace}")
+            print(f"Description: {description}")
+            print(f"Auto-save: {'enabled' if self.auto_save else 'disabled'}")
+
+        def deploy(self, project_name: str, environment: str = "staging", force: bool = False) -> None:
+            """Deploy project to specified environment."""
+            action = "Force deploying" if force else "Deploying"
+            print(f"{action} {project_name} to {environment}")
+
+
+if __name__ == '__main__':
+    cli = CLI(ProjectManager, title="Project Management Suite")
+    cli.display()
+```
+
+**Usage:**
+```bash
+# Global + Sub-global + Command arguments (all flat)
+python project_manager.py --config-file prod.json --debug \
+  database--migrate --connection-string postgres://prod --version 2.1.0 --dry-run
+
+# Create new project with custom workspace
+python project_manager.py projects--create --workspace /prod/projects --auto-save \
+  --name "web-app" --template "react" --description "Production web application"
+
+# Deploy with force flag
+python project_manager.py projects--deploy --project-name web-app --environment production --force
+
+# Beautiful help shows all flat commands organized by group
+python project_manager.py --help
+```
+
+## ✨ Key Features
+
+🚀 **Zero Configuration** - Works out of the box with just type annotations  
+⚡ **Lightning Fast** - No runtime dependencies, minimal overhead  
+🎯 **Type Safe** - Automatic validation from your type hints  
+📚 **Auto Documentation** - Help text generated from your docstrings  
+🎨 **Beautiful Output** - Professional themes and formatting  
+🔧 **Flexible Architecture** - Module-based or class-based patterns  
+📦 **No Dependencies** - Uses only Python standard library  
+🌈 **Shell Completion** - Bash, Zsh, Fish, and PowerShell support  
+✅ **Production Ready** - Battle-tested in enterprise applications  
+
+## 📚 Documentation
+
+**[📖 Complete Documentation Hub](docs/README.md)** - Everything you need to master Freyja
+
+### Quick Links
+* **[🚀 Getting Started](docs/getting-started/README.md)** - Installation and first steps
+* **[👤 User Guide](docs/user-guide/README.md)** - Comprehensive guides for both CLI modes  
+* **[⚙️ Features](docs/features/README.md)** - Type annotations, themes, completion, and more
+* **[📋 Examples & Best Practices](docs/guides/README.md)** - Real-world examples and patterns
+* **[❓ FAQ](docs/faq.md)** - Frequently asked questions
+* **[🔧 API Reference](docs/reference/README.md)** - Complete API documentation
+
+## 🛠️ Development
+
+**[📖 Development Guide](CLAUDE.md)** - Comprehensive guide for contributors
+
+### Quick Setup
+
+```bash
+# Clone and setup
+git clone https://github.com/tangledpath/freyja.git
+cd freyja
+
+# Install Poetry and setup environment  
+curl -sSL https://install.python-poetry.org | python3 -
+./bin/setup-dev.sh
+
+# Run tests and examples
+./bin/test.sh
+poetry run python examples/mod_example.py --help
+poetry run python examples/cls_example.py --help
+```
+
+### Development Commands
+
+```bash
+poetry install              # Install dependencies
+./bin/test.sh              # Run tests with coverage
+./bin/lint.sh              # Run all linters and formatters
+poetry build               # Build package
+./bin/publish.sh           # Publish to PyPI (maintainers)
+```
+
+## ⚙️ Requirements
+
+* **Python 3.13.5+** (recommended) or Python 3.8+
+* **Zero runtime dependencies** - uses only Python standard library
+* **Type annotations required** - for automatic CLI generation
+* **Docstrings recommended** - for automatic help text generation
+
+---
+
+**Ready to transform your Python code into powerful CLIs?**
+
+```bash
+pip install freyja
+# Start building amazing command-line tools in minutes! ⚡
+```
+
+**[📚 Get Started Now →](docs/getting-started/README.md)**

freyja-0.0.0/freyja/__init__.py

@@ -0,0 +1,8 @@
+"""
+Freyja: Zero-configuration FreyjaCLI generator from classes/module introspection.
+Uses class/method/function introspection, typehints, and docstrings to build
+a fully functional FreyjaCLI.  Command groups can be made with inner-classes,
+effectively making subclasses.
+"""
+from .freyja_cli import FreyjaCLI
+__all__ = [FreyjaCLI]

freyja-0.0.0/freyja/cli/__init__.py

@@ -0,0 +1,11 @@
+from .class_handler import ClassHandler
+from .execution_coordinator import ExecutionCoordinator
+from .enums import TargetMode
+from .system import SystemClassBuilder
+
+__all__ = [
+  ClassHandler,
+  ExecutionCoordinator,
+  SystemClassBuilder,
+  TargetMode,
+]