1. Clone the repository:

git clone https://github.com/kumarsonu676/python-fastapi-starter-api-project
cd python-fastapi-starter-api-project

2. Create and activate a virtual environment:

py -m venv venv
venv\Scripts\activate #venv\scripts\activate for windows

3. Install dependencies:

pip install -r requirements.txt

OR

py -m pip install -r requirements.txt

#to update requirements.txt file =>
py -m pip freeze > requirements.txt

4. Create a .env file based on .env.example:

cp .env.example .env

5. Start the application:

python main.py

OR

py -m main

Docker Development

1. Clone the repository:

git clone https://github.com/kumarsonu676/python-fastapi-starter-api-project
cd python-fastapi-starter-api-project

2. Create a .env file based on .env.example:

cp .env.example .env

3. Start the containers:

docker-compose up -d

Access the API

The API will be available at http://localhost:8000.

API documentation is available at:

• Swagger UI: http://localhost:8000/api/v1/docs
• ReDoc: http://localhost:8000/api/v1/redoc

Development

Adding a New Endpoint

1. Create a new file in app/api/v1/endpoints/
2. Create Pydantic models in app/schemas/
3. Add SQLAlchemy models in app/models/ if needed
4. Implement business logic in app/services/
5. Create repository in app/repositories/ for data access
6. Add the router to app/api/v1/api.py

Database Migrations

# Initialize migrations (first time only)
py -m alembic init alembic

# Create a new migration
py -m alembic revision --autogenerate -m "Migration message"

# Run migrations
py -m alembic upgrade head

Generate SQL Script from migration/revision name

#  For the first migration— When it has no parent (Revises: is empty).
py -m alembic upgrade base:<revision_name> --sql > migration_script.sql

# If you want to generate a script that can be used to downgrade from the current revision to the base revision, you can use:
py -m alembic downgrade base --sql > migration_script.sql

# For the subsequent migration— When it has a parent (Revises: <revision_name>).
# This will generate a script that can be used to upgrade from the previous revision to the current one.
py -m alembic upgrade <from_rev>:<to_rev> --sql > migration_script.sql

# If you want the SQL to downgrade from to_rev back to from_rev, just reverse the order:
py -m alembic downgrade <to_rev>:<from_rev> --sql > migration_script.sql

# To list all revisions and order:
py -m alembic history --verbose

# To show the current revision:
py -m alembic current

# To inspect details of a specific revision:
py -m alembic show <revision_name>

Environment Variables

Key environment variables for configuration:

• API_V1_STR: API version prefix
• SECRET_KEY: Secret key for JWT tokens
• POSTGRES_SERVER: PostgreSQL server address
• POSTGRES_USER: PostgreSQL username
• POSTGRES_PASSWORD: PostgreSQL password
• POSTGRES_DB: PostgreSQL database name

License

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

Acknowledgements

• FastAPI
• SQLAlchemy
• Pydantic
• Alembic

2. Activate the virtual environment:

   # On Windows
   venv\Scripts\activate
   
   # On Linux/Mac
   source venv/bin/activate
   

3. Run the application:

   python main.py
   

4. Access the API at http://localhost:8000