https://github.com/profcomff/fastapi-template
Шаблон для разработки backend-сервиса на fastapi
https://github.com/profcomff/fastapi-template
cookiecutter fastapi pydantic python3 sqlalchemy sqlalchemy-orm
Last synced: 7 months ago
JSON representation
Шаблон для разработки backend-сервиса на fastapi
- Host: GitHub
- URL: https://github.com/profcomff/fastapi-template
- Owner: profcomff
- License: bsd-3-clause
- Created: 2022-10-23T18:34:36.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-10T16:30:01.000Z (about 1 year ago)
- Last Synced: 2025-03-28T18:55:14.989Z (7 months ago)
- Topics: cookiecutter, fastapi, pydantic, python3, sqlalchemy, sqlalchemy-orm
- Language: Python
- Homepage:
- Size: 75.2 KB
- Stars: 19
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Шаблон для fastapi проекта
## Использование
1. Установите cookiecutter
```console
foo@bar:~$ pip install cookiecutter
```
2. Перейдите в ту директорию, где у вас будет хранится код для проекта. Это делается следующими комадами. (Это _не_ последовательность команд, а _список_ нужных Гуглите их, если у вас будет что-то не получаться.)
```console
foo@bar:~$ cd
foo@bar:~$ pwd
foo@bar:~$ ls
```
3. Выполните раскатку шаблона в текущую директорию командой
```console
foo@bar:~$ cookiecutter https://github.com/profcomff/fastapi-template.git
```
После команды вас спросят, хотите ли вы загрузить шаблон, согласитесь.
Вам зададут несколько вопросов:
1. `repo_name` - имя будущего репозитория
2. `module_name` - имя модуля, который будет запускаться командой: python3 -m module_name. На одном уровне с ним будут лежать Dockerfile, .gitignore, .env, Makefile, docker-compose, pyproject.toml, flake8.conf, README.md, requirements.txt, alembic.ini, gunicorn.conf, миграции. А внутри будет лежать исполняемый код.
3. `description` - Краткое описание проекта для README.md
4. У вас создастся структура проекта, корнем которой будет папка repo_name. Вы должны создать новый пустой репозиторий на GitHub и импортировать туда все из этой папки.
## Стек технологий в шаблоне
1) fastapi
2) sqlalchemy
3) pydantic
4) alembic
Вы можете добавлять новые технологии в файле requirements.txt.
## Предложения по шаблону
Писать мне @Alevardo (tg) или в нашем чатике