chickpea

chickpea

Generated by ProggerAI - Automated AI code generation platform

Tech Stack

• Framework: FastAPI 0.104.1
• Python: 3.11+
• Database: PostgreSQL 15
• Container: Docker + Docker Compose
• Testing: pytest

Project Structure

chickpea/
├── main.py                 # FastAPI application entry point
├── requirements.txt        # Python dependencies
├── Dockerfile             # Container definition
├── docker-compose.yml     # Multi-container orchestration
├── .env.example          # Environment variable template
├── .env                  # Local environment (create from .env.example)
├── tests/                # Test suite
│   └── test_main.py      # Main test file
└── README.md             # This file

Quick Start

Local Development (Python)

1. Install dependencies:

   pip install -r requirements.txt

2. Configure environment:

   cp .env.example .env
   # Edit .env with your configuration

3. Run the application:

   python main.py

4. Access the API:

   • API: http://localhost:8000
   • Interactive docs: http://localhost:8000/docs
   • Health check: http://localhost:8000/health

Docker Development

1. Start all services:

   docker-compose up -d

2. View logs:

   docker-compose logs -f api

3. Stop services:

   docker-compose down

Testing

# Run all tests
pytest

# Run with coverage
pytest --cov=. --cov-report=html

# Run specific test
pytest tests/test_main.py::test_health_check

API Endpoints

General

• GET / - API information
• GET /health - Health check endpoint
• GET /docs - Interactive API documentation (Swagger UI)
• GET /redoc - Alternative API documentation (ReDoc)

Add your endpoints here as you develop

Environment Variables

See .env.example for all available configuration options.

Required variables:

• DATABASE_URL - PostgreSQL connection string
• SECRET_KEY - Application secret key

Development

Adding New Endpoints

1. Define Pydantic models in the data models section
2. Add route handlers with proper type hints
3. Document with docstrings and OpenAPI tags
4. Add tests in tests/test_main.py

Database Migrations

(Add Alembic migration instructions when you add database models)

Production Deployment

1. Set ENVIRONMENT=production in .env
2. Set DEBUG=False
3. Configure proper SECRET_KEY
4. Use production-grade database
5. Configure CORS appropriately
6. Set up SSL/TLS
7. Configure logging and monitoring

Generated by ProggerAI

This project was generated by ProggerAI's autonomous AI agents. The code follows industry best practices and includes:

• ✅ RESTful API design
• ✅ OpenAPI documentation
• ✅ Type hints and validation
• ✅ Error handling
• ✅ Health checks
• ✅ Docker support
• ✅ Test suite
• ✅ Environment configuration

License

[Add your license here]