initial commit

Author: ArielMAJ

.env.example

@@ -0,0 +1,4 @@
+APPLICATION_HOST=127.0.0.1
+APPLICATION_PORT=3000
+
+APPLICATION_ROOT=

.gitignore

@@ -0,0 +1,160 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

.pre-commit-config.yaml

@@ -0,0 +1,104 @@
+repos:
+  - repo: https://github.com/python-poetry/poetry
+    rev: "1.7.0"
+    hooks:
+      - id: poetry-check
+        args: [--directory=backend]
+      - id: poetry-lock
+        args: [--directory=backend]
+      - id: poetry-install
+        args: [--directory=backend]
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+        exclude: ^.*\.egg-info/
+      - id: check-merge-conflict
+      - id: check-case-conflict
+      - id: check-json
+      - id: check-toml
+        exclude: tests/fixtures/invalid_lock/poetry\.lock
+      - id: check-yaml
+      - id: check-ast
+      - id: debug-statements
+      - id: check-docstring-first
+
+  - repo: https://github.com/psf/black
+    rev: 23.12.0
+    hooks:
+      - id: black
+        language_version: python3.9
+        args:
+          [
+            --line-length=88,
+            --target-version=py311,
+            --exclude=\.venv/,
+            --exclude=\.nox/,
+            --exclude=\.tox/,
+            --exclude=\.eggs/,
+            --exclude=build/,
+            --exclude=dist/,
+            --exclude=docs/,
+            --exclude=\.mypy_cache/,
+            --exclude=\.pytest_cache/,
+            --exclude=\.git/,
+            --exclude=\.github/,
+            --exclude=\.vscode/,
+            --exclude=\.pyright/,
+            --exclude=\.pylint_cache/,
+            --exclude=\.hypothesis/,
+            --exclude=\.mypy/,
+            --exclude=\.coverage/,
+          ]
+
+  - repo: https://github.com/pycqa/flake8
+    rev: 6.1.0
+    hooks:
+      - id: flake8
+        args: [--max-line-length=88, --ignore=E203]
+
+  - repo: https://github.com/myint/autoflake
+    rev: v2.2.1
+    hooks:
+      - id: autoflake
+        args:
+          [
+            "--in-place",
+            "--remove-all-unused-imports",
+            "--remove-unused-variables",
+            "--remove-duplicate-keys",
+            ".",
+          ]
+
+  - repo: https://github.com/pycqa/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+        args: [--filter-files, --profile=black, --src-path=src, --gitignore]
+
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v4.0.0-alpha.6
+    hooks:
+      - id: prettier
+        additional_dependencies:
+          - prettier@2.8.1
+
+  - repo: https://github.com/pre-commit/pre-commit
+    rev: v3.6.0
+    hooks:
+      - id: validate_manifest
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.8
+    hooks:
+      - id: ruff
+
+  - repo: local
+    hooks:
+      - id: export-requirements
+        name: Export requeriments.txt
+        language: system
+        pass_filenames: false
+        entry: poetry export --without-hashes -o requirements.txt -f requirements.txt
+        files: ^(pyproject\.toml|poetry\.lock)$

.python-version

@@ -0,0 +1 @@
+3.9.18

Makefile

@@ -0,0 +1,42 @@
+ifneq ("$(wildcard .env)","")
+	include .env
+	export
+endif
+
+
+.PHONY: run
+run: ## Run the project.
+	poetry run python -m api
+
+.PHONY: install
+install: ## Install Python requirements.
+	python -m pip install --upgrade pip setuptools wheel poetry
+	poetry lock
+	poetry install --no-root
+	poetry run pre-commit install
+
+.PHONY: test
+test: ## Run tests.
+	ENVIRONMENT=test poetry run pytest --cov
+
+.PHONY: pre-commit
+pre-commit: ## Run pre-commit checks.
+	poetry run pre-commit run --config ./.pre-commit-config.yaml
+
+.PHONY: patch
+patch: ## Bump project version to next patch (bugfix release/chores).
+	poetry version patch
+
+.PHONY: minor
+minor: ## Bump project version to next minor (feature release).
+	poetry version minor
+
+.PHONY: clean
+clean: ## Clean project's temporary files.
+	find . -name '__pycache__' -exec rm -rf {} +
+	find . -name '*.pyc' -exec rm -f {} +
+	find . -name '*.log' -exec rm -f {} +
+
+.DEFAULT_GOAL := help
+help:
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sed 's/Makefile://g' | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'

README.md

@@ -0,0 +1,5 @@
+# fastapi-backend-template
+
+A FastAPI backend template for a head start on new projects.
+
+See `Makefile` for examples on how to run the project.

api/__init__.py

@@ -0,0 +1,19 @@
+import uvicorn
+from api.config import Config
+
+
+def main() -> None:
+    """Entrypoint of the application."""
+    uvicorn.run(
+        "api.app:get_app",
+        workers=Config.WORKERS_COUNT,
+        host=Config.HOST,
+        port=Config.PORT,
+        reload=Config.RELOAD,
+        log_level=Config.LOG_LEVEL.lower(),
+        factory=True,
+    )
+
+
+if __name__ == "__main__":
+    main()

api/__main__.py

@@ -0,0 +1,36 @@
+from pathlib import Path
+
+from api.entrypoints.router import api_router
+from fastapi import FastAPI
+from fastapi.middleware.cors import CORSMiddleware
+from fastapi.responses import JSONResponse
+from fastapi_cache import FastAPICache
+from fastapi_cache.backends.inmemory import InMemoryBackend
+
+APP_ROOT = Path(__file__).parent
+
+
+def get_app() -> FastAPI:
+    """
+    Get FastAPI application.
+
+    This is the main constructor of an application.
+
+    :return: application.
+    """
+    _app = FastAPI(
+        title="fastapi-backend-template",
+        default_response_class=JSONResponse,
+    )
+
+    _app.add_middleware(
+        CORSMiddleware,
+        allow_origins=["*"],
+        allow_credentials=True,
+        allow_methods=["*"],
+        allow_headers=["*"],
+    )
+    _app.include_router(router=api_router)
+
+    FastAPICache.init(InMemoryBackend(), prefix="fastapi-cache")
+    return _app