From 3741f984e92c39de1a7d699415fcd3e0cdc134f0 Mon Sep 17 00:00:00 2001 From: dm1sh Date: Wed, 11 Oct 2023 20:52:01 +0300 Subject: [PATCH] Updated RADME.md --- parser/README.md | 10 +++++----- runner/README.md | 18 ++---------------- 2 files changed, 7 insertions(+), 21 deletions(-) diff --git a/parser/README.md b/parser/README.md index 5672c3d..9a26d18 100644 --- a/parser/README.md +++ b/parser/README.md @@ -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` diff --git a/runner/README.md b/runner/README.md index fc4b06d..eda6017 100644 --- a/runner/README.md +++ b/runner/README.md @@ -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 ``` \ No newline at end of file