amen-cli 0.6.0

A laravel installer inspired Python Web Application Scaffolding Tool

🚀 AMEN CLI

A laravel installer inspired Python Web Application 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
• 🏗️ Modular project structure (see below)
• 🔄 Automatic virtual environment setup
• 📦 Dependency management
• 🏗️ Structured project scaffolding
• 🧪 Test scaffolding with pytest
• 🔄 Update checker for the CLI
• 🚀 Command to run your application

🛠️ Installation

Using pip (All platforms)

pip install amen-cli

Using uv

uv is a very fast Python package installer and resolver, written in Rust.

To install amen-cli using uv:

1. Install uv:

   pip install uv
   

2. Install amen-cli using uv:

   uv pip install amen-cli
   

uv utilizes the pyproject.toml file for resolving dependencies, ensuring a consistent and reproducible installation.

Debian/Ubuntu

# Install required dependencies
sudo apt-get update
sudo apt-get install python3-pip python3-venv

# Install AMEN CLI
pip3 install amen-cli

# Optional: Install system-wide (requires root)
sudo pip3 install amen-cli

Linux Post-Installation

Make sure the amen command is in your PATH:

export PATH="$HOME/.local/bin:$PATH"

Add this line to your ~/.bashrc or ~/.zshrc for permanent effect.

📖 Usage

# Create a new project
amen create

# You can also use flags to specify the framework, type, and name:
amen create -f flask -t webapp -n myapp

# Available options:
# -f, --framework   Framework to use (flask, fastapi, bottle, pyramid)
# -t, --type        Type of application (webapp, api)
# -n, --name        Name of the application

# If flags are not provided, the interactive prompts will be used.

# Follow the interactive prompts to:
# 1. Select a framework
# 2. Choose application type (webapp/api)
# 3. Name your project

Additional Commands

# Run your application
amen run <app_name>

# Example:
amen run myapp

# Run tests for your application
amen test <app_name>

# Example:
amen test myapp

# Check for updates to the CLI
amen check-update

# Manage project configuration
amen config <app_name>

# Example:
amen config myapp

🌟 Project Structure

When you create a project, AMEN now generates a modular structure:

your-app/
├── venv/                   # Virtual environment
├── your-app/               # Main application package
│   ├── api/                # API endpoints (endpoints.py)
│   ├── auth/               # Authentication (token.py, etc.)
│   ├── models/             # Models module
│   ├── static/             # Static files (CSS, JS, images)
│   │   ├── uploads/
│   │   ├── css/
│   │   └── js/
│   ├── templates/          # HTML templates (if webapp)
│   └── app.py / main.py    # Main application file (Flask: app.py, FastAPI: main.py)
├── tests/                  # Test files
├── docs/                   # Documentation
├── requirements.txt        # Python dependencies
├── .env                    # Environment variables (local)
├── .env.example            # Environment variables template
├── .gitignore              # Git ignore rules
├── run.py                  # Application runner
└── README.md               # This file

• Flask: Uses app.py and registers a blueprint from api/endpoints.py. Token authentication is in auth/token.py.
• FastAPI: Uses main.py and includes a router from api/endpoints.py. Token authentication is in auth/token.py.
• Webapp: Includes HTML templates and static files. FastAPI mounts static and template directories.
• API: Generates only API endpoints and disables template/static mounting.

🎯 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

# 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
Or
#Before you cd into your project you can run the following 
amen run <appname>

🔧 Development

# 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 --cov

🤝 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 file for details.

👥 Contact & Support

• 🌐 GitHub Repository
• 🐛 Issue Tracker
• 📧 Send Email

⭐ Credits

Created by Tanaka Chinengundu
Inspired by Laravel's elegant development experience

---

Made with ❤️ by Tanaka Chinengundu