amen-cli 0.1.0__tar.gz

amen_cli-0.1.0/LICENSE

@@ -0,0 +1,43 @@
+Modified MIT License with Attribution Requirements
+
+Copyright (c) 2024 Tanaka Chinengundu
+
+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, subject to the following conditions:
+
+1. The above copyright notice, this permission notice, and the following attribution
+   requirements shall be included in all copies or substantial portions of the Software.
+
+2. Attribution Requirements:
+   a. All copies or substantial portions of the Software must retain clear and visible
+      attribution to the original author, Tanaka Chinengundu.
+   b. The original author's name (Tanaka Chinengundu) must not be removed, modified,
+      or obscured in any derivative works or modifications of the Software.
+   c. Any modifications or derivative works must clearly indicate that changes have
+      been made from the original Software and must not imply endorsement by the
+      original author.
+
+3. Liability and Responsibility:
+   a. The original author shall not be held responsible or liable for any damages, 
+      losses, or consequences arising from the use, misuse, or failure of the Software,
+      whether in its original or modified form.
+   b. Users and modifiers of the Software assume all risks associated with its use,
+      including but not limited to data loss, system failure, or other damages.
+   c. Any modifications made to the Software are the sole responsibility of the modifier,
+      and the original author bears no responsibility for derivative works.
+
+4. Additional Restrictions:
+   a. The Software may not be used in any way that implies endorsement by the original author.
+   b. The Software may not be used for illegal or malicious purposes.
+   c. Users must notify end users if they are using a modified version 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.

amen_cli-0.1.0/PKG-INFO

@@ -0,0 +1,189 @@
+Metadata-Version: 2.4
+Name: amen-cli
+Version: 0.1.0
+Summary: composer-inspired Python web framework scaffolding tool
+Home-page: https://github.com/taqsblaze/amen-cli
+Author: Tanaka Chinengundu
+Author-email: tanakah30@gmail.com
+Project-URL: Bug Reports, https://github.com/taqsblaze/amen-cli/issues
+Project-URL: Source, https://github.com/taqsblaze/amen-cli
+Project-URL: Documentation, https://github.com/taqsblaze/amen-cli#readme
+Keywords: python,web-framework,cli,scaffold,amen,composer,laravel,flask,django,fastapi,bottle,pyramid
+Classifier: Development Status :: 3 - Alpha
+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.11
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.0.0
+Requires-Dist: rich>=12.0.0
+Requires-Dist: questionary>=1.10.0
+Requires-Dist: virtualenv>=20.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=6.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=2.0.0; extra == "dev"
+Requires-Dist: black>=21.0.0; extra == "dev"
+Requires-Dist: flake8>=3.9.0; extra == "dev"
+Requires-Dist: mypy>=0.900; extra == "dev"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# 🚀 AMEN CLI   ![icon](https://raw.githubusercontent.com/TaqsBlaze/amen-cli/refs/heads/main/image/icon.png)
+A composer-inspired Python Web Framework Scaffolding Tool that helps you create web applications with ease!
+
+## ✨ Features
+
+- 🎯 Interactive project setup wizard
+- 🔧 Multiple framework support:
+  - Flask - Lightweight WSGI framework
+  - FastAPI - Modern, fast API framework
+  - Bottle - Simple micro web framework 🚧
+  - Pyramid - Flexible web framework 🚧
+- 🎨 Project templates for both web apps and APIs
+- 🔄 Automatic virtual environment setup
+- 📦 Dependency management
+- 🏗️ Structured project scaffolding
+
+## 🛠️ Installation
+
+```bash
+pip install amen-cli
+```
+
+## 📖 Usage
+
+```bash
+# Create a new project
+amen create
+
+# Follow the interactive prompts to:
+# 1. Select a framework
+# 2. Choose application type (webapp/api)
+# 3. Name your project
+```
+
+## 🌟 Project Structure
+
+When you create a project, AMEN generates:
+
+```
+your-app/
+├── venv/                   # Virtual environment
+├── app/                    # Main application code
+│   ├── templates/         # HTML templates (webapp)
+│   └── static/           # Static files
+│       ├── css/         # Stylesheets
+│       └── js/          # JavaScript files
+├── tests/                 # Test directory
+├── requirements.txt       # Python dependencies
+├── .env                  # Environment variables
+└── README.md             # Project documentation
+```
+
+## 🎯 Supported Frameworks
+
+| Framework | Description | Default Port | Status |
+|-----------|-------------|--------------|--------|
+| Flask | Lightweight WSGI web framework | 5000 | ✅ |
+| FastAPI | Modern, fast web framework | 8000 | ✅ |
+| Django | High-level Python web framework | 8000 | ❌ |
+| Bottle | Fast, simple micro framework | 8080 | 🚧 |
+| Pyramid | Flexible web framework | 6543 | 🚧 |
+
+## Work in Progress
+Currently implementing support for additional web frameworks:
+
+- **Bottle**: Integration in development
+- **Pyramid**: Initial implementation phase
+
+These frameworks will enable:
+- Route mapping and handling
+- Request/response processing
+- Middleware integration
+- Template rendering support
+
+Check back for updates or follow the project's issues for implementation progress. Contributions are welcome!
+
+> Note: For now, please use our stable implementations for Flask or FastAPI.
+## 🚗 Quick Start
+
+```bash
+# Install AMEN CLI
+pip install amen-cli
+
+# Create a new project
+amen create
+
+# Follow the interactive prompts
+
+# Navigate to your project
+cd your-project-name
+
+# Activate virtual environment
+source venv/bin/activate  # Linux/Mac
+venv\Scripts\activate     # Windows
+
+# Run your application
+python run.py
+```
+
+## 🔧 Development
+
+```bash
+# Clone the repository
+git clone https://github.com/taqsblaze/amen-cli.git
+
+# Install for development and testing
+pip install -e .
+pip install pytest pytest-cov
+
+# Run tests
+pytest
+
+# Run tests with coverage
+pytest
+```
+
+## 🤝 Contributing
+
+Contributions are welcome! Here's how:
+
+1. Fork the repository
+2. Create your feature branch: `git checkout -b feature/amazing-feature`
+3. Make your changes
+4. Push to the branch: `git push origin feature/amazing-feature`
+5. Open a Pull Request
+
+## 📝 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 👥 Contact & Support
+
+- 🌐 [GitHub Repository](https://github.com/taqsblaze/amen-cli)
+- 🐛 [Issue Tracker](https://github.com/taqsblaze/amen-cli/issues)
+- 📧 [Send Email](mailto:tanakah30@gmail.com)
+
+## ⭐ Credits
+
+Created by [Tanaka Chinengundu](https://www.linkedin.com/in/taqsblaze)  
+Inspired by Laravel's elegant development experience
+
+---
+
+Made with ❤️ by Tanaka Chinengundu

amen_cli-0.1.0/README.md

@@ -0,0 +1,144 @@
+# 🚀 AMEN CLI   ![icon](https://raw.githubusercontent.com/TaqsBlaze/amen-cli/refs/heads/main/image/icon.png)
+A composer-inspired Python Web Framework Scaffolding Tool that helps you create web applications with ease!
+
+## ✨ Features
+
+- 🎯 Interactive project setup wizard
+- 🔧 Multiple framework support:
+  - Flask - Lightweight WSGI framework
+  - FastAPI - Modern, fast API framework
+  - Bottle - Simple micro web framework 🚧
+  - Pyramid - Flexible web framework 🚧
+- 🎨 Project templates for both web apps and APIs
+- 🔄 Automatic virtual environment setup
+- 📦 Dependency management
+- 🏗️ Structured project scaffolding
+
+## 🛠️ Installation
+
+```bash
+pip install amen-cli
+```
+
+## 📖 Usage
+
+```bash
+# Create a new project
+amen create
+
+# Follow the interactive prompts to:
+# 1. Select a framework
+# 2. Choose application type (webapp/api)
+# 3. Name your project
+```
+
+## 🌟 Project Structure
+
+When you create a project, AMEN generates:
+
+```
+your-app/
+├── venv/                   # Virtual environment
+├── app/                    # Main application code
+│   ├── templates/         # HTML templates (webapp)
+│   └── static/           # Static files
+│       ├── css/         # Stylesheets
+│       └── js/          # JavaScript files
+├── tests/                 # Test directory
+├── requirements.txt       # Python dependencies
+├── .env                  # Environment variables
+└── README.md             # Project documentation
+```
+
+## 🎯 Supported Frameworks
+
+| Framework | Description | Default Port | Status |
+|-----------|-------------|--------------|--------|
+| Flask | Lightweight WSGI web framework | 5000 | ✅ |
+| FastAPI | Modern, fast web framework | 8000 | ✅ |
+| Django | High-level Python web framework | 8000 | ❌ |
+| Bottle | Fast, simple micro framework | 8080 | 🚧 |
+| Pyramid | Flexible web framework | 6543 | 🚧 |
+
+## Work in Progress
+Currently implementing support for additional web frameworks:
+
+- **Bottle**: Integration in development
+- **Pyramid**: Initial implementation phase
+
+These frameworks will enable:
+- Route mapping and handling
+- Request/response processing
+- Middleware integration
+- Template rendering support
+
+Check back for updates or follow the project's issues for implementation progress. Contributions are welcome!
+
+> Note: For now, please use our stable implementations for Flask or FastAPI.
+## 🚗 Quick Start
+
+```bash
+# Install AMEN CLI
+pip install amen-cli
+
+# Create a new project
+amen create
+
+# Follow the interactive prompts
+
+# Navigate to your project
+cd your-project-name
+
+# Activate virtual environment
+source venv/bin/activate  # Linux/Mac
+venv\Scripts\activate     # Windows
+
+# Run your application
+python run.py
+```
+
+## 🔧 Development
+
+```bash
+# Clone the repository
+git clone https://github.com/taqsblaze/amen-cli.git
+
+# Install for development and testing
+pip install -e .
+pip install pytest pytest-cov
+
+# Run tests
+pytest
+
+# Run tests with coverage
+pytest
+```
+
+## 🤝 Contributing
+
+Contributions are welcome! Here's how:
+
+1. Fork the repository
+2. Create your feature branch: `git checkout -b feature/amazing-feature`
+3. Make your changes
+4. Push to the branch: `git push origin feature/amazing-feature`
+5. Open a Pull Request
+
+## 📝 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 👥 Contact & Support
+
+- 🌐 [GitHub Repository](https://github.com/taqsblaze/amen-cli)
+- 🐛 [Issue Tracker](https://github.com/taqsblaze/amen-cli/issues)
+- 📧 [Send Email](mailto:tanakah30@gmail.com)
+
+## ⭐ Credits
+
+Created by [Tanaka Chinengundu](https://www.linkedin.com/in/taqsblaze)  
+Inspired by Laravel's elegant development experience
+
+---
+
+Made with ❤️ by Tanaka Chinengundu

amen_cli-0.1.0/amen/__init__.py

@@ -0,0 +1,25 @@
+"""AMEN CLI - Python Web Framework Scaffolding Tool"""
+__version__ = "0.1.0"
+__author__ = "Tanaka Chinengundu"
+
+__description__ = "A composer-inspired Python Web Framework Scaffolding Tool"
+__license__ = "Modified MIT with Attribution Requirements"
+__copyright__ = "Copyright (c) 2025 Tanaka Chinengundu"
+__email__ = "tanakah30@gmail.com"
+__url__ = "https://github.com/taqsblaze/amen-cli"
+__docs__ = "https://github.com/taqsblaze/amen-cli/#readme"
+__python_requires__ = ">=3.7"
+
+SUPPORTED_FRAMEWORKS = {
+    "flask": {"version": ">=2.0.0", "port": 5000},
+    "fastapi": {"version": ">=0.68.0", "port": 8000}
+}
+
+# Package status
+__status__ = "Development"
+__maintainer__ = "Tanaka Chinengundu"
+__credits__ = ["Tanaka Chinengundu"]
+
+# Feature flags
+ENABLE_LOGGING = True
+DEBUG_MODE = True

amen_cli-0.1.0/amen/cli.py

@@ -0,0 +1,230 @@
+import os
+import sys
+import subprocess
+import venv
+from pathlib import Path
+
+import click
+import questionary
+from rich.console import Console
+from rich.panel import Panel
+from rich.progress import Progress, SpinnerColumn, TextColumn
+
+from .frameworks import FRAMEWORKS
+from .templates import TemplateManager
+
+console = Console()
+
+VALID_FRAMEWORKS = ['flask', 'fastapi', 'bottle', 'pyramid']
+VALID_PROJECT_TYPES = ['webapp', 'api']
+
+def create_project(path, framework, project_type):
+    """
+    Create a new project with the specified framework and type.
+    
+    Args:
+        path (str): Project directory path
+        framework (str): Web framework to use
+        project_type (str): Type of project (webapp/api)
+    """
+    if framework not in VALID_FRAMEWORKS:
+        raise ValueError(f"Invalid framework. Choose from: {VALID_FRAMEWORKS}")
+    
+    if project_type not in VALID_PROJECT_TYPES:
+        raise ValueError(f"Invalid project type. Choose from: {VALID_PROJECT_TYPES}")
+
+    # Create project directory
+    os.makedirs(path, exist_ok=True)
+    
+    # Create basic structure
+    os.makedirs(os.path.join(path, "app"), exist_ok=True)
+    os.makedirs(os.path.join(path, "app", "templates"), exist_ok=True)
+    os.makedirs(os.path.join(path, "app", "static"), exist_ok=True)
+    
+    # Create empty files
+    open(os.path.join(path, "requirements.txt"), 'a').close()
+    open(os.path.join(path, "README.md"), 'a').close()
+
+class AmenCLI:
+    def __init__(self):
+        self.template_manager = TemplateManager()
+    
+    def welcome_banner(self):
+        """Display welcome banner"""
+        console.print(Panel.fit(
+            """AMEN: composer-inspired Python Web Framework Scaffolding
+        Create your web applications with ease!
+        By [bold magenta]Tanaka Chinengundu[/bold magenta]
+        [bold blue]
+            """,
+            border_style="magenta"
+        ))
+        console.print()
+    
+    def select_framework(self) -> str:
+        """Interactive framework selection"""
+        frameworks = list(FRAMEWORKS.keys())
+        
+        choice = questionary.select(
+            "🚀 Select a web framework:",
+            choices=[
+                questionary.Choice(f"{FRAMEWORKS[fw]['name']} - {FRAMEWORKS[fw]['description']}", fw)
+                for fw in frameworks
+            ]
+        ).ask()
+        
+        return choice
+    
+    def select_app_type(self) -> str:
+        """Select application type"""
+        return questionary.select(
+            "🏗️  What type of application?",
+            choices=[
+                questionary.Choice("Full Web Application (with frontend)", "webapp"),
+                questionary.Choice("API Only", "api"),
+            ]
+        ).ask()
+    
+    def get_app_name(self) -> str:
+        """Get application name"""
+        return questionary.text(
+            "📝 Enter your application name:",
+            validate=lambda x: len(x.strip()) > 0 or "Application name cannot be empty"
+        ).ask().strip()
+    
+    def create_virtual_environment(self, app_path: Path) -> bool:
+        """Create virtual environment"""
+        venv_path = app_path / "venv"
+        
+        try:
+            with Progress(
+                SpinnerColumn(),
+                TextColumn("[progress.description]{task.description}"),
+                console=console,
+            ) as progress:
+                task = progress.add_task("Creating virtual environment...", total=None)
+                venv.create(venv_path, with_pip=True)
+                progress.update(task, description="✅ Virtual environment created")
+            
+            return True
+        except Exception as e:
+            console.print(f"❌ Error creating virtual environment: {e}", style="red")
+            return False
+    
+    def install_framework(self, app_path: Path, framework: str) -> bool:
+        """Install selected framework in virtual environment"""
+        venv_path = app_path / "venv"
+        
+        # Determine pip path based on OS
+        if sys.platform == "win32":
+            pip_path = venv_path / "Scripts" / "pip"
+        else:
+            pip_path = venv_path / "bin" / "pip"
+
+        framework_info = FRAMEWORKS[framework]
+        packages = framework_info['packages']
+        
+        try:
+            with Progress(
+                SpinnerColumn(),
+                TextColumn("[progress.description]{task.description}"),
+                console=console,
+            ) as progress:
+                task = progress.add_task(f"Installing {framework_info['name']}...", total=None)
+                
+                for package in packages:
+                    subprocess.run([
+                        str(pip_path), "install", package
+                    ], check=True, capture_output=True)
+                
+                progress.update(task, description=f"✅ {framework_info['name']} installed")
+            
+            return True
+        except subprocess.CalledProcessError as e:
+            console.print(f"❌ Error installing {framework_info['name']}: {e}", style="red")
+            return False
+    
+    def create_app(self):
+        """Main app creation flow"""
+        self.welcome_banner()
+        
+        # Get user choices
+        framework = self.select_framework()
+        if not framework:
+            console.print("❌ No framework selected. Exiting.", style="red")
+            return
+            
+        app_type = self.select_app_type()
+        if not app_type:
+            console.print("❌ No application type selected. Exiting.", style="red")
+            return
+            
+        app_name = self.get_app_name()
+        if not app_name:
+            console.print("❌ No application name provided. Exiting.", style="red")
+            return
+
+        # Create application directory
+        app_path = Path.cwd() / app_name
+        
+        if app_path.exists():
+            overwrite = questionary.confirm(
+                f"Directory '{app_name}' already exists. Overwrite?"
+            ).ask()
+            
+            if not overwrite:
+                console.print("❌ Operation cancelled.", style="yellow")
+                return
+            
+            import shutil
+            shutil.rmtree(app_path)
+
+        app_path.mkdir()
+        console.print(f"📁 Created directory: {app_path}", style="green")
+
+        # Create virtual environment
+        if not self.create_virtual_environment(app_path):
+            return
+
+        # Install framework
+        if not self.install_framework(app_path, framework):
+            return
+
+        # Generate project structure
+        with Progress(
+            SpinnerColumn(),
+            TextColumn("[progress.description]{task.description}"),
+            console=console,
+        ) as progress:
+            task = progress.add_task("Generating project structure...", total=None)
+            self.template_manager.generate_structure(app_path, framework, app_type, app_name)
+            progress.update(task, description="✅ Project structure generated")
+
+        # Success message
+        console.print(Panel(
+            f"""🎉 Successfully created '{app_name}'!
+
+📁 Next Steps:
+   1. cd {app_name}
+   2. source venv/bin/activate  (Linux/Mac) or venv\\Scripts\\activate (Windows)  
+   3. python run.py
+
+Your app will be running at http://localhost:{FRAMEWORKS[framework]['default_port']}
+            """.strip(),
+            title="🎊 Project Created Successfully!",
+            border_style="green"
+        ))
+
+@click.group()
+def main():
+    """Amen - composer-inspired Python web framework scaffolding tool"""
+    pass
+
+@main.command()
+def create():
+    """Create a new web application"""
+    cli = AmenCLI()
+    cli.create_app()
+
+if __name__ == "__main__":
+    main()

amen_cli-0.1.0/amen/frameworks.py

@@ -0,0 +1,46 @@
+"""Framework configurations and metadata"""
+
+FRAMEWORKS = {
+    'flask': {
+        'name': 'Flask',
+        'description': 'Lightweight WSGI web application framework',
+        'packages': ['flask', 'flask-cors', 'python-dotenv'],
+        'default_port': 5000,
+        'entry_file': 'app.py',
+    },
+    # 'django': {
+    #     'name': 'Django',
+    #     'description': 'High-level Python web framework',
+    #     'packages': ['django', 'django-cors-headers', 'python-dotenv'],
+    #     'default_port': 8000,
+    #     'entry_file': 'manage.py',
+    # },
+    'fastapi': {
+        'name': 'FastAPI',
+        'description': 'Modern, fast web framework for building APIs',
+        'packages': ['fastapi', 'uvicorn[standard]', 'python-dotenv'],
+        'default_port': 8000,
+        'entry_file': 'main.py',
+    },
+    # 'bottle': {
+    #     'name': 'Bottle',
+    #     'description': 'Fast, simple micro web framework',
+    #     'packages': ['bottle', 'python-dotenv'],
+    #     'default_port': 8080,
+    #     'entry_file': 'app.py',
+    # },
+    # 'pyramid': {
+    #     'name': 'Pyramid',
+    #     'description': 'Flexible, open source web framework',
+    #     'packages': ['pyramid', 'waitress', 'python-dotenv'],
+    #     'default_port': 6543,
+    #     'entry_file': 'app.py',
+    # },
+    # 'django-hotsauce': {
+    #     'name': 'Django Hotsauce',
+    #     'description': 'Django-based rapid development framework',
+    #     'packages': ['django', 'django-hotsauce', 'python-dotenv'],
+    #     'default_port': 8000,
+    #     'entry_file': 'manage.py',
+    # }
+}

amen_cli-0.1.0/amen/templates/__init__.py

@@ -0,0 +1,3 @@
+from .manager import TemplateManager
+
+__all__ = ['TemplateManager']