uvicorn-poetry-fastapi-project-template - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #react #golang #android #deep-learning #macos #nodejs #cli #vue #security #pytorch #ios #open-source

uvicorn-poetry-fastapi-project-template

(★ 102)

Cookiecutter project template for starting a FastAPI application. Runs in a Docker container with Uvicorn ASGI server on Kubernetes. Supports AMD64 and ARM64 CPU architectures.

File Explorer

Download Latest Version (.zip)

- - pipeline.yml
- dependabot.yml
- post_gen_project.py
- __init__.py
- conftest.py
- constants.py
- test_custom_config.py
- test_default_config.py
- test_docker_image_build.py
- test_tools.py
- - __init__.py
  - main.py
- - __init__.py
  - conftest.py
- .dockerignore
- .gitignore
- .pre-commit-config.yaml
- Dockerfile
- pyproject.toml
- README.md
.gitignore
.pre-commit-config.yaml
cookiecutter.json
LICENSE
poetry.lock
pyproject.toml
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![codecov](https://codecov.io/gh/max-pfeiffer/uvicorn-poetry-fastapi-project-template/graph/badge.svg?token=OFQU8YVFAR)](https://codecov.io/gh/max-pfeiffer/uvicorn-poetry-fastapi-project-template)
![pipeline workflow](https://github.com/max-pfeiffer/uvicorn-poetry-project-template/actions/workflows/pipeline.yml/badge.svg)
# Uvicorn Poetry FastAPI Project Template
[Cookiecutter](https://github.com/cookiecutter/cookiecutter) project template for starting a containerized Fast API project.

It uses [Poetry](https://python-poetry.org/) for managing dependencies and setting up a virtual environment locally and in the container.

The project is set up to produce a Docker image to run your application with [Uvicorn](https://github.com/encode/uvicorn) on [Kubernetes](https://kubernetes.io/) container orchestration system.

## Quick Start
First [install Poetry](https://python-poetry.org/docs/#installation) on your machine.

Then [install Cookiecutter](https://cookiecutter.readthedocs.io/en/latest/installation.html) on your machine. Create your project using the template:
```shell
cookiecutter https://github.com/max-pfeiffer/uvicorn-poetry-project-template
```

### Run with Poetry
In project directory install dependencies:
```shell
poetry install
```
Run application in project directory:
```shell
poetry run uvicorn --workers 1 --host 0.0.0.0 --port 8000 app.main:app
```

### Build and run Docker image
Build the production Docker image:
```shell
docker build --tag my-application:1.0.0 .
```
Run the containerized application:
```shell
docker run -it --rm my-application:1.0.0
```