FastAPI Web Applications¶

This directory contains FastAPI web applications showcasing modern Python web API development, each with its own pyproject.toml for dependency management.

Technologies: Django • FastAPI • PyTest • Python • SQLite

FastAPI Web Applications¶

This directory contains FastAPI web applications showcasing modern Python web API development, each with its own pyproject.toml for dependency management.

Project Structure¶

fastapi/
├── todo-api/                   # Todo List API service
│   ├── pyproject.toml         # Dependencies & project config
│   ├── src/fastapi_todo_list/ # Main FastAPI application
│   ├── tests/                 # Test suite
│   ├── build_package.py       # Package building utilities
│   └── README.md              # Project documentation
├── LICENSE                     # MIT License
└── README.md                   # This file

Projects¶

1. todo-api (Main API Service)¶

Purpose: A robust FastAPI-based todo list API with full CRUD operations

FastAPI with automatic OpenAPI documentation
SQLAlchemy ORM with SQLite database
Pydantic models for data validation
Comprehensive CRUD operations with timestamps
Full test coverage with pytest
Automatic completion timestamp tracking

Technologies Used¶

FastAPI: Modern, fast web framework for building APIs
SQLAlchemy: SQL toolkit and ORM
Pydantic: Data validation using Python type annotations
SQLite: Lightweight database for development
Uvicorn: ASGI web server implementation
Pytest: Testing framework

Quick Start¶

Each project can be run independently with its own dependencies:

cd todo-api
pip install -e .
uvicorn src.fastapi_todo_list.main:app --reload

Visit http://localhost:8000/docs for interactive API documentation.

Development Notes¶

All projects use modern pyproject.toml configuration
Code follows FastAPI best practices and patterns
Comprehensive testing with pytest
Automatic API documentation generation
Type hints throughout for better IDE support

API Endpoints¶

Overview¶

GET / - Welcome message with endpoint overview

Todo Operations¶

GET /todos - Get all active (incomplete) todos
GET /todos/completed - Get all completed todos
GET /todos/all - Get all todos regardless of status
GET /todos/{id} - Get a specific todo by ID
POST /todos - Create a new todo
PUT /todos/{id} - Update an existing todo
DELETE /todos/{id} - Delete a todo

Building & Distribution¶

Build the Package¶

# Install build tools
pip install build twine

# Build the package
python -m build

This creates distribution files in the dist/ directory:

fastapi_todo_list-1.0.0-py3-none-any.whl (wheel)
fastapi_todo_list-1.0.0.tar.gz (source distribution)

Publish to Feed¶

Option 1: PyPI (Public Registry)¶

# Test PyPI (recommended first)
twine upload --repository testpypi dist/*

# Production PyPI
twine upload dist/*

Option 2: GitHub Packages¶

# Configure GitHub token first
# Then upload to GitHub Packages
twine upload --repository-url https://upload.pypi.org/legacy/ dist/*

Option 3: GitHub Releases¶

# Manual upload to: https://github.com/amalieshi/amalie_projects/releases
# Or use GitHub CLI:
gh release create v1.0.0 dist/* --title "FastAPI Todo List v1.0.0"

Option 4: Private Feed/Repository¶

# Azure DevOps, JFrog Artifactory, Nexus, etc.
twine upload --repository-url https://your-private-feed-url dist/*

Your GitHub Repository Feed URLs:

Releases: https://github.com/amalieshi/amalie_projects/releases
Repository: https://github.com/amalieshi/amalie_projects.git
Package Directory: python/web-frameworks/fastapi/

Development Tools¶

The project includes configuration for development tools:

# Code formatting with black
black src/

# Type checking with mypy
mypy src/

# Linting with flake8
flake8 src/

# Run tests
pytest

Usage Examples¶

Create a new todo¶

curl -X POST "http://localhost:8000/todos" \
     -H "Content-Type: application/json" \
     -d '{"title": "Buy groceries", "description": "Milk, bread, and eggs"}'

Get all active todos¶

curl "http://localhost:8000/todos"

Mark a todo as completed¶

curl -X PUT "http://localhost:8000/todos/1" \
     -H "Content-Type: application/json" \
     -d '{"completed": true}'

Get completed todos¶

curl "http://localhost:8000/todos/completed"

Delete a todo¶

curl -X DELETE "http://localhost:8000/todos/1"

Data Model¶

Each todo item contains:

id: Unique identifier (auto-generated)
title: Todo title (required)
description: Optional description
completed: Boolean completion status
created_at: Creation timestamp
updated_at: Last modification timestamp
completed_at: Completion timestamp (null if not completed)

Database¶

The application uses SQLite with SQLAlchemy ORM for data persistence. The database file (todos.db) is created automatically when the application starts.

Interactive Documentation¶

FastAPI automatically generates interactive API documentation:

Swagger UI: http://localhost:8000/docs
ReDoc: http://localhost:8000/redoc

These interfaces allow you to test all endpoints directly from your browser.

Development¶

To extend the application:

Add new database models in database.py
Create corresponding Pydantic schemas in schemas.py
Implement CRUD operations in crud.py
Add new endpoints in main.py

Technologies Used¶

FastAPI: Modern, fast web framework for building APIs
SQLAlchemy: SQL toolkit and ORM
Pydantic: Data validation using Python type hints
SQLite: Lightweight database engine
Uvicorn: ASGI server for running the application

← Back to Python Web-Frameworks Projects

FastAPI Web Applications¶