polinamaltz/vk_get_friends_report

Parsing VK with vk_api

VK get friends report
Back-end test task for Junior Developer

Introduction 📢

Система позволяет получить информацию о друзьях пользователя по его id в социальной сети "Вконтакте" и сформировать отчет в 3 поддерживаемых форматах - csv, tsv, json.

Входные данные:

1. Авторизационный токен (TOKEN);
   
2. ID пользователя, по которому генерируем отчет (USER_ID);
   
3. Формат выходного файла. По умолчанию - CSV (OUTPUT_TYPE);
   
4. Путь к выходному файлу. По умолчанию - файл с именем report в текущей директории (OUTPUT_PATH);
   

Ввод данных осуществляется через файл constants.py.

How it works? ⁉️

Система оформлена в ООП стиле, где глобальная цель - получить информацию о друзьях пользователя - поделена на микрозадачи, и каждый отдельный объект выполняет свою задачу. Внутри системы реализованы следующие объекты:

1. FriendsGetter (friends_getter/friends_getter.py) - отправляет запрос к API и получает список id всех друзей заданного пользователя.
   
2. DataGetter (data_getter/data_getter.py) - отправляет запрос по всем id сразу к API и получает в ответ информацию, доступную в профиле пользователей.
   
3. CsvWriter (file_writers/csv_writer/csv_writer.py) - получает данные в виде списка словарей и записывает их в конечный датасет формата CSV.
   
4. TsvWriter (file_writers/tsv_writer/tsv_writer.py) - получает данные в виде списка словарей и записывает их в конечный датасет формата TSV.
   
5. JsonWriter (file_writers/json_writer/json_writer.py) - получает данные в виде списка словарей и обрабатывает их для дампа в JSON файл.
   

Обращение к VK API осуществляется через библиотеку vk_api. (Документация)

Помимо основных объектов в системе присутствует директория utils для функций обработки данных. Вся работа выполнена в соответствии с PEP8, легко масштабируема. Например, для поддержки нового формата выходных данных достаточно написать отдельный модуль и использовать его в функции main() внутри main.py. Так же в системе имеется простейшее логирование в консоль.