README fix

Author: EEnota

README.md

@@ -1,30 +1,30 @@
 # NEWS_API_ETL_Project
 
 ### Цель
-обрабатывать из внешенго Api новости и используя принцип ETL сохранять нужные новости в базу данных.
+Обрабатывать из внешнего API новости и используя принцип ETL сохранять нужные новости в базу данных.
 
 ### Стек
-Extract: requests(страна, категоия, ключевое слово, размер страницы (опционально)) -> сохранение статей в папку data/raw
+Extract: requests(страна, категория, ключевое слово, размер страницы (опционально)) -> сохранение статей в папку data/raw
 
-Transform: Python скрипт читает данные из нового файла data/raw, смотрит чтобы были указаны: автор, заголовок, описание не меньше 20 символов, url ссылка
+Transform: Python скрипт читает данные из нового файла data/raw, проверяет чтобы были указаны: автор, заголовок, описание не меньше 20 символов, url ссылка
 
-Load: psycopg2 подключается к PostgreSQL, перед вставкой разрешается конфлик с уникальной url ссылкой. Если такая ссылка уже есть то новость не добавляется в таблицу
+Load: psycopg2 подключается к PostgreSQL, перед вставкой разрешается конфликт с уникальной url ссылкой. Если такая ссылка уже есть то новость не добавляется в таблицу
 
-db: создается база данных и таблица если их еще нет. url присваивается UNICE
+db: создается база данных и таблица если их еще нет. url присваивается UNIQUE
 
-Пайплайн: программа запускается скриптом разделенным на 5 основных модулей (db.py, extract.py, load.py, transform.py, main.py)
+Pipeline: программа запускается скриптом разделенным на 5 основных модулей (db.py, extract.py, load.py, transform.py, main.py)
 
 ### Схема ETL
-top-headlines из NewsApi (extract) -> Филтр на наличие автора, заголовка, описания не меньше 20 символов, наличие url (transform) -> загрузка статей чей url отстуствует в базе данных (load)
+top-headlines из NewsApi (extract) -> Филтр на наличие автора, заголовка, описания не меньше 20 символов, наличие url (transform) -> загрузка статей чей url отсутствует в базе данных (load)
 
-### Стуктура папок
+### Структура папок
 ```text
 project/
 ├── config
 |   └── config.py
 ├── data /
-|   ├──raw / # тут будут хранится статьи до обработки в формате json
-|   └──clean / # тут будут хранится статьи после обработки
+|   ├──raw / # тут будут храниться статьи до обработки в формате json
+|   └──clean / # тут будут храниться статьи после обработки
 ├── notebooks /
 |   └── 01_eda.ipynb
 ├── src /
@@ -39,7 +39,7 @@ project/
 ```
 
 ### Порядок запуска
-#### склонировать репу 
+#### склонировать репозиторий 
 ```bash
 git clone [сслыка на репозиторий]
 ```
@@ -51,23 +51,26 @@ cd <repo_name>
 #### создать виртуальное окружение
 ```bash
 py -m venv .venv
-
+```
+после чего
+```bash
 .venv\Scripts\Activate.ps1
 ```
+
 #### установить библиотеки
 ``` bash
 pip install -r requirements.txt
 ```
 
 #### скопировать .env.exsample
 ``` bash
-copy .env.exsample .env
+copy .env.example .env
 ```
 Заполнить .env вашими данными
 
 #### запустить код
 ```bash
-python main.py --keyword your_key_word --category your_category --limit your_limit_of_articles --page_size your_page_size
+python main.py --keyword your_key_word --category your_category --limit your_articles_limit --page_size your_page_size
 ```
 
 ### пример .env
@@ -82,5 +85,5 @@ NEWSAPI_KEY =your_key
 ```
 
 ### Важные моменты
-в папку data/raw сохраняются все статьи которые были получены за 1 запрос по вашим критериям. Им в качетсве имени присваивается текущее дата-время, ключевое слово и текущая страница. 
+в папку data/raw сохраняются все статьи которые были получены за 1 запрос по вашим критериям. Им в качестве имени присваивается текущее дата-время, ключевое слово и текущая страница. 
 в папку data/clean попадают все статьи которые имеют: автора, заголовок, описание 20+ символов и url ссылку. им присвается имя аналогичным способом что и в data/raw однако первым словом в имени является cleaned

src/extract.py

@@ -34,8 +34,9 @@ def make_extract(category: str, key_word: str, page: int = 1, page_size: int = 1
     }
     try:
         data = r.get(settings.NEWS_URL, params=params, timeout=15)
+        data.raise_for_status()
         payload = data.json()
-        logger.info(f"raise of status: {data.raise_for_status()}")
+        logger.info(f"raise of status: {data.status_code}")
         payload["fetched_at"] = datetime.now().isoformat()
         payload["country"] = settings.COUNTRY
         payload["category"] = category