🚀 vyte - Rapid Development Tool

Professional API project generator for Python. Create production-ready REST APIs in seconds.

---

✨ Features

• 🎯 Multiple Frameworks: Flask-Restx, FastAPI, Django-Rest
• 🗄️ Multiple ORMs: SQLAlchemy, TortoiseORM, Peewee, Django ORM
• 💾 Database Support: PostgreSQL, MySQL, SQLite
• 🔐 JWT Authentication: Secure authentication out of the box
• 🐳 Docker Ready: Complete Docker and docker-compose setup
• 🧪 Testing Suite: Pytest with coverage reports
• 📚 Auto Documentation: Swagger/OpenAPI automatic docs
• ⚡ Modern Stack: Python 3.11+, Pydantic v2, async support
• 🎨 Beautiful CLI: Rich terminal UI with interactive setup

🚀 Quick Start

Installation

# Using pip
pip install vyte

# Using pipx (recommended)
pipx install vyte

# From source
git clone https://github.com/PabloDomi/Vyte.git
cd vyte
pip install -e .

Create Your First Project

# Interactive mode (recommended)
vyte create

# Or specify options directly
vyte create \
  --name my-api \
  --framework FastAPI \
  --orm SQLAlchemy \
  --database PostgreSQL

What You Get

my-api/
├── src/
│   ├── __init__.py          # App factory
│   ├── main.py              # Entry point
│   ├── config/
│   │   └── config.py        # Pydantic settings
│   ├── models/
│   │   └── models.py        # Database models
│   ├── routes/
│   │   └── routes_example.py
│   ├── services/
│   └── security.py          # JWT & security
├── tests/
│   ├── test_api.py
│   ├── test_models.py
│   └── conftest.py
├── requirements.txt
├── requirements-dev.txt
├── Dockerfile
├── docker-compose.yml
├── .env.example
├── .gitignore
├── pytest.ini
└── README.md

📖 Usage

Interactive Mode

The easiest way to create a project:

vyte create

Follow the prompts to configure your project.

Command Line Options

vyte create \
  --name my-api \
  --framework FastAPI \
  --orm SQLAlchemy \
  --database PostgreSQL \
  --auth \
  --docker \
  --tests \
  --git

Available Commands

# Create new project
vyte create

# Show framework information
vyte info FastAPI

# List all frameworks and ORMs
vyte list

# Show dependencies for configuration
vyte deps FastAPI --orm SQLAlchemy

# Validate existing project
vyte validate ./my-api

# Open documentation
vyte docs

# Show version
vyte --version

🎯 Supported Combinations

Framework	Compatible ORMs	Async Support
Flask-Restx	SQLAlchemy, Peewee	❌ Sync
FastAPI	SQLAlchemy (async), TortoiseORM	✅ Async
Django-Rest	Django ORM	❌ Sync

🔧 Configuration

Projects use Pydantic Settings for configuration:

# .env file
DATABASE_URL=postgresql://user:pass@localhost:5432/mydb
JWT_SECRET_KEY=your-secret-key-here
ENVIRONMENT=development
DEBUG=True

🧪 Testing

Generated projects include complete testing setup:

# Run tests
pytest

# With coverage
pytest --cov=src --cov-report=html

# Open coverage report
open htmlcov/index.html

🐳 Docker Support

Run your project with Docker:

# Build and run
docker-compose up -d

# View logs
docker-compose logs -f

# Stop
docker-compose down

📚 Documentation

• Full Documentation
• Quick Start Guide
• CLI Reference
• API Reference

🤝 Contributing

Contributions are welcome! Please read our Contributing Guide.

# Clone repo
git clone https://github.com/PabloDomi/Vyte.git
cd vyte

# Setup development environment
pip install -e ".[dev]"
pip install pre-commit black ruff isort

# Install pre-commit hooks
pre-commit install

# Run tests
pytest

# Format code
make format

# Run linters
make lint

# Run full CI suite
make ci

🗺️ Roadmap

Check out our Roadmap to see what's planned for future releases!

Coming in v2.1.0:

• vyte upgrade - Upgrade existing projects
• vyte add-model - Add models to projects
• Customizable templates
• MongoDB support

📝 License

MIT License - see LICENSE file for details.

🙏 Acknowledgments

• Built with Click
• UI powered by Rich
• Templates with Jinja2
• Validation with Pydantic

📊 Project Stats

• Test Coverage: 73%
• Code Quality: A+ (Ruff, Black)
• Security: Scanned with Bandit
• Python Versions: 3.11, 3.12
• Platforms: Linux, macOS, Windows

📧 Contact

• Issues: GitHub Issues
• Discussions: GitHub Discussions
• Email: Domi@usal.es

---

Made with ❤️ by Pablo Domínguez Blanco