Updated RADME.md

This commit is contained in:
Dmitriy Shishkov 2023-10-11 20:52:01 +03:00
parent b52be1a89c
commit 3741f984e9
Signed by: dm1sh
GPG Key ID: 027994B0AA357688
2 changed files with 7 additions and 21 deletions

View File

@ -1,4 +1,4 @@
# Rosseti parser
# Lenenergo parser
## Описание
@ -6,9 +6,9 @@
## Интерфейс
- `RossetiParser`:
- `LenenergoParser`:
```python
class RossetiParser:
class LenenergoParser:
def __init__(self, ndays=7, today: Optional[datetime] = None, file_path: Optional[str] = None) -> None
self.base_url: str
@ -67,7 +67,7 @@ def group_by_index(df: pd.DataFrame) -> pd.DataFrame
```
- `pipeline`:
```python
def pipeline(parser: Optional[RossetiParser] = None) -> RossetiParser
def pipeline(parser: Optional[LenenergoParser] = None) -> LenenergoParser
```
## Инструкция по запуску
@ -79,7 +79,7 @@ python -m venv .venv
pip install -r requirements.txt
python -m rosseti_parser [<Период в часах>]
python -m parser [<Период в часах>]
```
Формат сохраняемых файлов: `data_%d-%m-%y_%H:%M.csv`

View File

@ -1,18 +1,4 @@
# Parser API
## Описание
FastAPI REST API, предоставляющий доступ к данным с сайта [Россети Ленэнерго](https://rosseti-lenenergo.ru/planned_work/).
## Доступные методы
- GET `/api/list` - Поиск по каждому полю в отдельности
- GET `/api/search` - Поиск по всем полям сразу
- GET `/api/check` - Проверка, является ли отключение в вашем доме сейчас официальным и если да, то когда сеть снова включат.
- PUT `/api/create` - Отладочное поле для добавления записей в БД
- GET `/` - Healthcheck
Подробнее: [Swagger UI](http://localhost:8000/docs) когда запущенно приложение
# Runner
## Инструкция по запуску
@ -23,5 +9,5 @@ python -m venv .venv
pip install -r requirements.txt
python -m uvicorn parser_api.main:app
python -m runner
```