https://github.com/kieled/fastapi-aiopika-boilerplate

FastAPI, SQLAlchemy, aio_pika, RabbitMQ and Docker boilerplate
https://github.com/kieled/fastapi-aiopika-boilerplate

aio-pika async asynchronous boilerplate docker docker-compose fastapi python rabbitmq sqlalchemy

Last synced: about 1 month ago
JSON representation

FastAPI, SQLAlchemy, aio_pika, RabbitMQ and Docker boilerplate

• Host: GitHub
• URL: https://github.com/kieled/fastapi-aiopika-boilerplate
• Owner: kieled
• Created: 2023-04-04T15:41:18.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-04-04T19:36:43.000Z (over 1 year ago)
• Last Synced: 2024-11-20T19:54:28.121Z (about 1 month ago)
• Topics: aio-pika, async, asynchronous, boilerplate, docker, docker-compose, fastapi, python, rabbitmq, sqlalchemy
• Language: Python
• Homepage:
• Size: 30.3 KB
• Stars: 20
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.MD

Awesome Lists containing this project

README

        
:small_red_triangle: FastAPI, SQLAlchemy 2, aio_pika, RabbitMQ boilerplate :small_red_triangle:


![abstract rectangles colorful with ragged edges per (2)](https://user-images.githubusercontent.com/68655454/229900974-2cd4b9e5-01a4-475a-9df7-f545118e7887.jpg)

### :heavy_check_mark: Features:

1. [x] _Project fully async_

2. [x] _SqlAlchemy async session_

3. [x] _docker-compose and Dockerfiles_

4. [x] _`RabbitConnection` class. Path: `src/config/rabbit_connection_py`_

5. [x] _Base logging configuration_

6. [x] _FastAPI Cors base configuration_

7. [x] _FastAPI lifespan feature_

8. [x] _Poetry package manager_

9. [x] _Used hypercorn_

10. [x] _Configurated default BaseSettings instance_

11. [x] _PostgreSQL database and asyncpg driver used_

### :lock: Dependencies:

```python

python = "^3.11"

fastapi = "^0.95.0"

hypercorn = "^0.14.3"

aio-pika = "^9.0.5"

sqlalchemy = "^2.0.8"

asyncpg = "^0.27.0"

```

### :checkered_flag: Setup

1. _Install Docker if not installed_

2. _Rename `.env.dev-example` to `.env.dev`_

3. _Run `docker compose up -d --build` command_

4. _Open `http://localhost:8000/docs` in your browser_

### :label: Tips:

* Logs you can find by path `src/logs`

* Also you can run command `docker compose logs` to check logs

* You can disable logging to the files by removing/commenting this code in the `consumer.py` and `main.py`:

```python

import logging

logging.basicConfig(

    level=logging.DEBUG,

    format='%(asctime)s %(levelname)s %(message)s',

    handlers=[

        logging.FileHandler("logs/fastapi.log"),

        logging.StreamHandler()

    ]

)

```