Skip to content

Commit 838f2d4

Browse files
committed
.
1 parent bbf5e3b commit 838f2d4

File tree

3 files changed

+10
-24
lines changed

3 files changed

+10
-24
lines changed

README.md

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,19 @@
1-
[Swagger](https://profastcode.github.io/FastAPI_Template/docs/)
1+
[Preview API](https://profastcode.github.io/FastAPI_Template/docs/)
22

33
## Настройка
44

55
#### Настройка происходит в файле .env его нет в репозитории, т.к. он конфиденциален, но я предоставил файл .env.dist создайте на его основе файл .env и проведите все необходимые настройки
66

7-
## Установка зависимостей
8-
9-
#### В основе проекта лежит пакетный менеджер poetry
10-
11-
`poetry install` - Вариант с использованием poetry.
12-
13-
`pip install -r requirements.txt` - Вариант с использованием pip.
14-
157
## Документация по make командам
168

17-
`make help` - Команда help отображает список доступных команд и их описание.
9+
`make help` - Отображает команды и их описание.
1810

19-
`make ref` - Команда ref используется для форматирования кода с помощью ruff и black.
11+
`make ref` - Форматирует код.
2012

21-
`make dev` - Команда dev запускает приложение в режиме разработки.
13+
`make dev` - Запускает приложение в режиме разработки.
2214

23-
`make req` - Команда req обновляет зависимости в [requirements.txt](requirements.txt)
15+
`make req` - Обновляет зависимости в [requirements.txt](requirements.txt)
2416

25-
`make migrate` - Команда migrate применяет все ожидающие миграции к базе данных с помощью alembic.
17+
`make migrate` - Применяет все миграции с помощью alembic.
2618

27-
`make generate` - Команда generate используется для генерации новой миграции базы данных с помощью alembic.
19+
`make generate` - Генерирует новую миграцию с помощью alembic.

app/__init__.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,10 @@
1111
title=settings.APP_TITLE,
1212
root_path=settings.APP_PATH,
1313
version=settings.APP_VERSION,
14-
description=settings.app_description,
1514
contact={
16-
'name': 'Fast Code',
17-
'url': 'https://fast-code.pro/',
18-
'email': 'fast.code.auth@gmail.com',
15+
"name": "Fast Code",
16+
"url": "https://fast-code.pro/",
17+
"email": "fast.code.auth@gmail.com",
1918
},
2019
)
2120

app/core/settings.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,6 @@ class Settings(BaseSettings):
1717
APP_VERSION: str = "beta"
1818
APP_SECRET_KEY: str = "abc"
1919

20-
@property
21-
def app_description(self):
22-
with open("README.md", "r", encoding="utf-8") as f:
23-
return f.read()
24-
2520
# DATABASE
2621
POSTGRES_DB: str = "postgres"
2722
POSTGRES_HOST: str = "127.0.0.1"

0 commit comments

Comments
 (0)