FastAPI Postgres Project

Overview

A robust web application built with FastAPI, PostgreSQL, and SQLAlchemy, featuring comprehensive database migrations and modern Python development practices.

🚀 Features

• FastAPI backend
• PostgreSQL database integration
• SQLAlchemy ORM
• Alembic database migrations
• Comprehensive GitHub Actions workflows
• CodeQL security analysis

🛠 Tech Stack

• Python 3.11
• FastAPI
• PostgreSQL
• SQLAlchemy
• Alembic
• GitHub Actions
• Docker (optional)

📦 Prerequisites

• Python 3.11+
• PostgreSQL
• pip

🔧 Installation

1. Clone Repository

git clone https://github.com/augsmachado/fastapi-postgres.git
cd fastapi-postgres

2. Create Virtual Environment

python -m venv venv
source venv/bin/activate  # On Windows use `venv\Scripts\activate`

3. Install Dependencies

pip install -r requirements.txt

4. Database Setup

# Configure your database connection in .env or environment variables
alembic upgrade head

🚦 Running the Application

uvicorn main:app --reload

🔍 Testing

pytest

🔐 Security

• CodeQL analysis integrated
• Dependabot for dependency updates
• Regular security scans

📋 Database Migrations

# Create a new migration
alembic revision --autogenerate -m "Description of changes"

# Apply migrations
alembic upgrade head

🤝 Contributing

Feel free to submit issues or pull requests for improvements or bug fixes. Use the framework below:

• Fork the repository
• Create your feature branch
• Commit your changes
• Push to the branch
• Create a Pull Request

📄 License

This project is licensed under the Apache License 2.0. See the LICENSE file for details.