This repository serves as a template for a minimal FastAPI project with enhanced logging using Loguru. It's managed with Poetry for efficient dependency resolution, ensuring a robust and maintainable codebase.
- FastAPI Framework: Utilizes the latest FastAPI framework for high performance and ease of development.
- Loguru Integration: Includes pre-configured Loguru for superior logging capabilities.
- Poetry for Dependency Management: Employs Poetry to simplify package management and dependency resolution.
- Black Code Style: Adheres to the Black code style for consistent and clean Python code.
- isort for Import Sorting: Ensures imports are neatly organized and consistent using isort.
- mypy for Static Type Checking: Incorporates mypy to catch errors and ensure type safety in your codebase.
- pytest for Testing: Leverages pytest for comprehensive and efficient testing of your application.
To use this template, simply press the button on GitHub to create a new repository based on this template. Next, rename the project and docker image in following files
pyproject.tomldocker-compose.yml.github/workflows/build-docker-image-release.yml- and uncomment the
onsection in this file for it to work
- and uncomment the
poetry installpoetry shell
poetry run appFor any issues or troubleshooting queries, please refer to the Issues section of this GitHub repository.
Contributions are welcome. Please fork the repository, make your changes, and submit a pull request.
This project is open-sourced under the MIT License.