Data

Tools

Indexes

Applications

Experiments

Open Source Science

fastapi-postgres

Template for building FastAPI Asynchronous applications with PostgreSQL(SQLModel)

https://github.com/darixsamani/fastapi-postgres

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (5.4%) to scientific vocabulary

Keywords

alembic async asynchronous asyncio docker docker-compose fastapi postgresql python3 sqlachemy sqlalchemy sqlmodel
Last synced: 4 months ago · JSON representation ·

Repository

Template for building FastAPI Asynchronous applications with PostgreSQL(SQLModel)

Basic Info
Statistics
  • Stars: 33
  • Watchers: 1
  • Forks: 11
  • Open Issues: 0
  • Releases: 0
Topics
alembic async asynchronous asyncio docker docker-compose fastapi postgresql python3 sqlachemy sqlalchemy sqlmodel
Created over 2 years ago · Last pushed 6 months ago
Metadata Files
Readme Citation

README.md

FastAPI Async Template with PostgreSQL

This is a template for building asynchronous FastAPI applications with PostgreSQL.

If you're looking to understand the project in depth, please refer to the full documentation here:
👉 Deep Documentation and Docker Hub Images

Features

  • Python FastAPI backend
  • POSTGRESQL Database
  • Docker-Compose
  • Authentification
  • Migration with Alembic
  • PGADMIN4 for Graphical Database Visualization
  • Asynchronous
  • Support SQLmodel

Here are the steps to follow to run the program:

After cloning the repository, go to it. 1. DOCKER COMPOSE ``` docker compose up -d --build

```
  1. RUN FRIST MIGRATION docker compose exec app uv run alembic revision --autogenerate -m "first migration" docker compose exec app uv run alembic upgrade head

  2. Please turn on the LISTEN Docs app. 0.0.0.0:8001/docs

  3. PGADMIN4

access to pgadmin by specified db as name server and 5434 as port at localhost/5050

username: admin@gmail.com password: admin

Please turn on the LISTEN Docs app. 0.0.0.0:5050

  1. EXAMPLE IMAGE

Owner

  • Name: Darix SAMANI SIEWE
  • Login: darixsamani
  • Kind: user
  • Location: Douala, Cameroon
  • Company: @DataTouchAnalytics, @hoozonsarl

Software Engineer

Citation (CITATION.cff) 

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: fastapi-postgres
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Darix
    family-names: SAMANI SIEWE
    email: samanidarix@gmail.com
    orcid: 'https://orcid.org/0009-0001-0794-7120'
repository-code: 'https://github.com/darixsamani/fastapi-postgres'
abstract: >-
  Template for building FastAPI Asynchronous applications
  with PostgreSQL(SQLModel)
keywords:
  - fastapi
  - sqlmodel
  - postgres
  - asynchronous
license: MIT

GitHub Events

Total
  • Watch event: 5
  • Push event: 5
  • Fork event: 3
Last Year
  • Watch event: 5
  • Push event: 5
  • Fork event: 3

Dependencies

Dockerfile docker
  • python 3.8 build
docker-compose.yml docker
  • postgres 12.4
requirements.txt pypi
  • Mako ==1.2.4
  • MarkupSafe ==2.1.3
  • SQLAlchemy ==2.0.19
  • alembic ==1.11.2
  • annotated-types ==0.5.0
  • anyio ==3.7.1
  • exceptiongroup ==1.1.2
  • fastapi ==0.101.0
  • greenlet ==2.0.2
  • idna ==3.4
  • pydantic ==2.1.1
  • pydantic_core ==2.4.0
  • python-dotenv ==1.0.0
  • sniffio ==1.3.0
  • starlette ==0.27.0
  • typing_extensions ==4.7.1
.github/workflows/docker-image.yml actions
  • actions/checkout v3 composite
tests/setup.py pypi