startfast 0.1.0

A comprehensive FastAPI project generator

⚡ StartFast

The Ultimate FastAPI Project Generator

Create scalable, production-ready FastAPI projects in seconds

---

✨ Features

🚀 Project Types	API • CRUD • ML-API • Microservice
💾 Databases	SQLite • PostgreSQL • MySQL • MongoDB • Redis
🔐 Authentication	JWT • OAuth2 • API Key • None
🐳 DevOps Ready	Docker • Docker Compose • Production configs
📊 Observability	Monitoring • Logging • Health checks
⚡ Performance	Async/Sync • Background tasks • Caching
🧪 Quality	Testing suite • Code formatting • Documentation

📦 Installation

🎯 Quick Install

pip install startfast

🛠️ Development Install

git clone https://github.com/Incognitol07/startfast.git
cd startfast
pip install -e .

---

🚀 Quick Start

⚡ Generate Your First Project

startfast my-awesome-api

🎨 Custom Configuration

startfast my-api --type crud --database postgresql --auth jwt --advanced

---

🎯 Usage

📋 Command Syntax

startfast PROJECT_NAME [OPTIONS]

⚙️ Configuration Options

Option	Description	Values
--path	Project directory	Directory path
--type	Project architecture	api, crud, ml-api, microservice
--database	Database backend	sqlite, postgresql, mysql, mongodb, redis
--auth	Authentication method	none, jwt, oauth2, api-key
--sync	Synchronous implementation	Flag
--advanced	Advanced features	Flag
--no-docker	Skip Docker setup	Flag
--no-tests	Skip test configuration	Flag
--no-docs	Skip documentation	Flag
--monitoring	Include observability	Flag
--celery	Background task support	Flag
--python-version	Python version	Version string (default: 3.11)
--force	Overwrite existing files	Flag

🌟 Usage Examples

🔧 Simple API with SQLite

startfast simple-api

🗄️ CRUD API with PostgreSQL and JWT

startfast crud-api --type crud --database postgresql --auth jwt

🤖 ML API with Advanced Features

startfast ml-service --type ml-api --advanced --monitoring

🏗️ Microservice with MongoDB and Celery

startfast micro-service --type microservice --database mongodb --celery

---

🏗️ Project Architecture

Generated projects follow a clean, scalable structure:

📁 my-project/
├── 📂 app/
│   ├── 🐍 __init__.py
│   ├── 🚀 main.py                 # FastAPI app entry point
│   ├── 📂 core/
│   │   ├── ⚙️ config.py          # Configuration management
│   │   └── 🔐 security.py        # Authentication & security
│   ├── 📂 api/
│   │   └── 📂 v1/                # API version 1
│   ├── 📂 models/                # Database models
│   ├── 📂 schemas/               # Pydantic schemas
│   ├── 📂 services/              # Business logic
│   └── 📂 utils/                 # Helper functions
├── 📂 tests/                     # Test suite
├── 📂 docs/                      # Documentation
├── 📄 requirements.txt           # Dependencies
├── 🐳 Dockerfile                # Container configuration
├── 🐙 docker-compose.yml        # Multi-service setup
└── 📖 README.md                 # Project documentation

---

🛠️ Development

🚧 Setup Development Environment

# Clone the repository
git clone https://github.com/Incognitol07/startfast.git
cd startfast

# Install in development mode
pip install -e ".[dev]"

# Setup pre-commit hooks
pre-commit install

🧪 Running Tests

pytest                    # Run all tests
pytest -v                 # Verbose output
pytest --cov              # With coverage report

🎨 Code Quality

black .                   # Format code
isort .                   # Sort imports
flake8 .                  # Lint code
mypy .                    # Type checking

---

🤝 Contributing

We welcome contributions! Here's how to get started:

🔄 Contribution Workflow

1. 🍴 Fork the repository
2. 🌿 Create your feature branch

   git checkout -b feature/amazing-feature
   

3. 💾 Commit your changes

   git commit -m 'Add some amazing feature'
   

4. 📤 Push to the branch

   git push origin feature/amazing-feature
   

5. 🔀 Open a Pull Request

📝 Contribution Guidelines

• Write clear, concise commit messages
• Add tests for new features
• Update documentation as needed
• Follow the existing code style
• Ensure all tests pass

---

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

🗺️ Roadmap

🔮 Upcoming Features

• 🌐 Web UI for project generation
• 📊 More database adapters (ClickHouse, TimescaleDB)
• 🎨 Custom template support
• 🔌 Plugin system for extensibility
• 💻 IDE integrations (VS Code, PyCharm)
• ☁️ Cloud deployment templates
• 📱 Mobile-first API templates

---

📞 Support & Community

� Get Help & Connect

🌟 Show Your Support

If StartFast helped you build amazing projects, consider giving it a ⭐!

---

Made with ❤️ by developers, for developers

Happy coding! 🚀