Skip to content

Welcome to Projex Documentation

🔨 Projex

A powerful CLI tool to generate production-ready Python project boilerplates instantly

PyPI version Python versions License GitHub stars

Why Projex?

Skip the boring setup and jump straight into coding! Projex generates complete, production-ready project structures with best practices baked in.

⚡ Quick Example

# Install
pip install projex

# Create your project
projex create my-api --template fastapi --db postgresql --auth jwt

# Start coding!
cd my-api
source venv/bin/activate
uvicorn app.main:app --reload

That's it! You now have a production-ready FastAPI project with PostgreSQL and JWT authentication! 🚀

✨ Key Features

🚀 Quick Start

Get started in 3 easy steps:

1. Install Projex

pip install projex

git clone https://github.com/ChAbdulWahhab/projex.git
cd projex
pip install -e .

2. Create Your Project

projex create
The CLI will guide you through the setup with interactive prompts.

projex create my-api --template fastapi --db postgresql

3. Start Development

cd my-api
source venv/bin/activate
pip install -r requirements.txt
uvicorn app.main:app --reload

Visit http://localhost:8000/docs for interactive API documentation! 📚

📋 What Gets Generated?

Every project includes:

✅ Production-ready structure - Best practices baked in
✅ Docker support - Dockerfile and docker-compose
✅ Testing setup - pytest with examples
✅ Environment config - .env file management
✅ Database integration - ORM/ODM configured
✅ Authentication - Ready to use auth system
✅ API documentation - Auto-generated docs
✅ Git initialization - Ready for version control

🎯 Use Cases

Microservices Architecture

projex create user-service --template fastapi
projex create order-service --template fastapi
projex create payment-service --template fastapi
Learn more about microservices →

REST API Development

projex create my-api --template fastapi --db postgresql --auth jwt
cd my-api
projex add cicd --provider github
REST API guide →

Full-Stack Application

projex create backend --template fastapi
projex create admin --template django
Full-stack setup →

📚 Next Steps

🤝 Community & Support

🗺️ Roadmap

Check out our Changelog for recent updates and the GitHub Projects for upcoming features.

Recently Added ✅

  • 8 framework templates
  • Smart scaffolding system
  • CI/CD pipeline generation
  • Environment management
  • Enhanced testing tools

Coming Soon 🚀

  • Frontend templates (React, Vue)
  • GraphQL support
  • Kubernetes configurations
  • Plugin system

Made with ❤️ by developers, for developers

GitHub • PyPI • Twitter