https://github.com/max-pfeiffer/uvicorn-poetry-fastapi-project-template

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.
https://github.com/max-pfeiffer/uvicorn-poetry-fastapi-project-template

amd64 arm64 cookiecutter cookiecutter-template docker fastapi kubernetes poetry python uvicorn

Last synced: 3 months ago
JSON representation

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.

• Host: GitHub
• URL: https://github.com/max-pfeiffer/uvicorn-poetry-fastapi-project-template
• Owner: max-pfeiffer
• License: mit
• Created: 2022-05-03T19:16:32.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-11-08T09:35:13.000Z (3 months ago)
• Last Synced: 2024-11-08T09:37:58.029Z (3 months ago)
• Topics: amd64, arm64, cookiecutter, cookiecutter-template, docker, fastapi, kubernetes, poetry, python, uvicorn
• Language: Python
• Homepage:
• Size: 369 KB
• Stars: 10
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![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-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

```