/habrahabr-api-python-client

Habrahabr API Client Library for Python

Primary LanguagePython

habrahabr-python - клиент API Хабрахабра на Python Build Status

Хабрахабр - самое крупное в Рунете сообщество людей, занятых в индустрии высоких технологий. Уникальная аудитория, свежая информация, конструктивное общение и коллективное творчество - всё это делает Хабрахабр самым оригинальным IT-проектом в России.

Данная библиотека предоставляет доступ к недавно появившемуся API Хабрахабра на языке Python. Она не является официальной и поддерживается пользователем kafeman в личных интересах.

Установка

$ sudo pip install habrahabr

Или можно собрать самую последнюю версию из исходников. Это несложно, достаточно выполнить следующие команды:

$ git clone https://github.com/kafeman/habrahabr-python && cd habrahabr-python
$ sudo python setup.py install

Теперь библиотека готова к использованию!

Быстрый старт

Перед началом работы с API Хабрахабра потребуется пройти несколько несложных этапов.

  1. Получение идентификатора приложения

    Воспользовавшись этой формой на Хабрахабре, нужно кратко описать суть нового приложения и цель, для которой ему нужен API.

    Через некоторое время будет получен идентификатор и секрет нового приложения. Держите секрет в секрете и никому его не давайте!

  2. Получение токена пользователя

    Каждое приложение может работать с API Хабра только от имени установившего его пользователя.

    Для получения токена можно воспользоваться следующим простым способом. Перейдите по следующей ссылке

    https://auth.habrahabr.ru/o/login/?redirect_uri=САЙТ&response_type=token&client_id=КЛИЕНТ

    поставив адрес сайта приложения вместо САЙТ и полученный на первом шаге идентификатор вместо КЛИЕНТ.

    После нажатия кнопки "Разрешить", Хабр выполнит перенаправление на САЙТ, добавив в конец адреса строку #token=..., которая и будет содержать требуемый токен.

  3. Создание тестового приложения

    Дошедший до этого шага ужее имеет всю мощь API Хабрахабра. Теперь самое время воспользоваться библиотеку. Для начала инициализируем ее:

    import habrahabr
api = habrahabr.Api(client='ваш ClientID',
                     token='ваш токен')

    Все дальнейшее взаимодействие с Хабром теперь будет происходить через объект api. Для примера, получим данные о пользователе "kafeman":

    author = api.users.get('kafeman')

    Переменная author теперь содержит объект с данными об авторе библиотеки.

Полная документация

К сожалению, какая-либо официальная документация API Хабрахабра отсутствует, а настоящая библиотека была написана командой первоклассных телепатов.

Однако, кое-что все таки получить можно. Если выполнить следующую команду, то вы сможете узнать назначение практически всех методов библиотеки.

pydoc habrahabr

Лицензия

Библиотека доступна на условиях лицензии Apache версии 2.0

http://www.apache.org/licenses/LICENSE-2.0