Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Pogchamp-company/fastapi-async-sqlalchemy-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

History

20 Commits

Repository files navigation

ProjectName

Description

Your project description

Getting Started

Prerequisites

  1. Python3
  2. PostgreSQL

Install & Run project

  1. Clone repo
git clone Your project url
  1. Create Python Virtual Environment
  2. Install requirements
pip install -r requirements/requirements.txt
  1. Create PostgreSQL database
  2. Make .env file
touch .env
  1. Set env variables
  2. Migrate database
# cd src
alembic upgrade head
  1. Run project
source venv/bin/activate
python manage.py serve --workers 1

Run tests

  1. Install tests requirements
pip install -r requirements/test_requirements.txt
  1. Create db with prefix "test_"
  2. Run pytest
source venv/bin/activate
pytest

Tests coverage

pytest --cov=app --cov-report=html --cov-config=.coveragerc tests/ 

Contributing

Code style

pep8 FastAPI Best Practices

Branch naming

{username}/{task_short_description}

Environment variables

Variable Description Default
DATABASE_URI PostgreSQL URI postgresql+asyncpg://postgres@localhost:5432/db_name
BACKEND_CORS_ORIGINS Frontend []
HOST - 127.0.0.1
PORT - 8000
DEBUG - False

Project structure

Project structure id described here

AltStyle によって変換されたページ (->オリジナル) /