Wykop API Python SDK

.. role:: strike :class: strike

.. image:: https://badge.fury.io/py/wykop-sdk.png :target: http://badge.fury.io/py/wykop-sdk

.. image:: https://travis-ci.org/p1c2u/wykop-sdk.svg?branch=master :target: https://travis-ci.org/p1c2u/wykop-sdk

.. image:: https://img.shields.io/codecov/c/github/p1c2u/wykop-sdk/master.svg?style=flat :target: https://codecov.io/github/p1c2u/wykop-sdk?branch=master

Biblioteka ta jest implementacją Wykop API_ w Python.

.. _Wykop API: http://www.wykop.pl/developers/api/

Przykładowe użycie:

import wykop

api = wykop.WykopAPI(klucz_aplikacji, sekret_aplikacji)
profile = api.get_profile("m__b")

Instalacja

Zalecana jest instalacja wykop-sdk poprzez pip:

$ pip install wykop-sdk

Alternatywnie możesz pobrać kod i zainstalować bezpośrednio z repozytorium:

$ pip install -e git+https://github.com/p1c2u/wykop-sdk.git#egg=wykop-sdk

Uwierzytelnienie

Aby wykonywać działania jako użytkownik zalogowany przed wykonaniem metody należy się uwierzytenić.

Przykładowe użycie metody wymagającej uwierzytelnienia:

import wykop

api = wykop.WykopAPI(klucz_aplikacji, sekret_aplikacji)
api.authenticate(login, klucz_polaczenia)
profile = api.observe_profile("m__b")

API wersja 1

Zdefiniowane metody ^^^^^^^^^^^^^^^^^^^

Biblioteka posiada wbudowane metody odpowiednie do zdefiniowanych w Wykop API

Proste żądania ^^^^^^^^^^^^^^^^^^^

Można również skorzystać z podstawowej metody do tworzenia żądań. Przykład z dokumentacji Wykop API będzie przedstawiał się następująco:

link = api.request("link", 'index', [54321,], {"appkey": 12345})

gdzie:

+-------------------+-------------------------+ | 'link' | typ zasobu | +-------------------+-------------------------+ | 'index' | metoda zasobu | +-------------------+-------------------------+ | [54321,] | lista parametrów metody | +-------------------+-------------------------+ | {"appkey": 12345} | parametry API | +-------------------+-------------------------+

Wykop Connect ^^^^^^^^^^^^^^^^^^^

Możliwe jest też łączenie konta użytkownika z aplikacją

Generowanie linku do Wykop Connect

url = api.get_connect_url("http://hostname.pl")

Dekodowanie danych Wykop Connect

appkey, login, token = api.get_connect_data(encoded_data)

Odpowiedzi ^^^^^^^^^^^^^^^^^^^

Wyróżniamy 3 typy odpowiedzi:

logiczny, np. metoda observe_profile: ::

>>> print api.observe_profile("m__b")
[True]

obiekt, np. metoda get_profile: ::

>>> print api.get_profile("m__b")
{'author_group': 5, 'buries': None, 'rank': 274, 'links_published': 41, 'gg': '', 'groups': 2, 'entries': 203, .. }

lista obiektów, np. metoda get_link_digs ::

>> print api.get_link_digs(12345)
[{'author_group': 2, 'author_sex': 'male', .. }, {'author_group': 2, 'author_sex': 'male', .. }]

Każdy obiekt z odpowiedzi jest typu słownikowego (dict) z możliwością dostępu do właściwości poprzez artybuty:

>> profile = api.get_profile("m__b")
>> profile["diggs"]
12155
>> profile.diggs
12155

Filtrowanie odpowiedzi ^^^^^^^^^^^^^^^^^^^^^^ Aby odfiltrować z odpowiedzi kod HTML, należy wywołać klasę z parametrem output='clear'

import wykop

api = wykop.WykopAPI(klucz_aplikacji, sekret_aplikacji, output='clear')
api.authenticate(login, klucz_polaczenia)
profile = api.observe_profile("m__b")

API wersja 2

Wykop posiada API w wersji 2. Jest to nowa, nieudokumentowana wersja API. Implementacja tej wersji w SDK może się zmieniać.

.. warning::

Uwierzytelnienie działa tylko z kluczami ze wsparciem dla tej wersji API.

Przykładowe użycie:

from wykop import WykopAPIv2

api = WykopAPIv2(klucz_aplikacji, sekret_aplikacji)
profile = api.get_profile("m__b")

Zdefiniowane metody ^^^^^^^^^^^^^^^^^^^

API w wersji 2 posiada następujące wbudowane metody.

+-------------------+--------------------------------+ | Metoda API | Metoda SDK | +-------------------+--------------------------------+ | Links | +-------------------+--------------------------------+ | ? | get_links_promoted | +-------------------+--------------------------------+ | ? | get_links_upcoming | +-------------------+--------------------------------+ | ? | get_link_comments | +-------------------+--------------------------------+ | ? | get_link_related | +-------------------+--------------------------------+ | ? | get_link_upvoters | +-------------------+--------------------------------+ | ? | get_link_downvoters | +-------------------+--------------------------------+ | MyWykop | +-------------------+--------------------------------+ | ? | get_mywykop | +-------------------+--------------------------------+ | ? | get_mywykop_tags | +-------------------+--------------------------------+ | ? | get_mywykop_users | +-------------------+--------------------------------+ | Notifications | +-------------------+--------------------------------+ | ? | get_notifications | +-------------------+--------------------------------+ | ? | get_notifications_count | +-------------------+--------------------------------+ | ? | get_hashtags_notifications | +-------------------+--------------------------------+ | ? | get_hashtags_notifications_cou | +-------------------+--------------------------------+ | Profiles | +-------------------+--------------------------------+ | ? | get_profile | +-------------------+--------------------------------+ | ? | observe_profile | +-------------------+--------------------------------+ | ? | unobserve_profile | +-------------------+--------------------------------+ | ? | block_profile | +-------------------+--------------------------------+ | ? | unblock_profile | +-------------------+--------------------------------+ | Search | +-------------------+--------------------------------+ | ? | search_links | +-------------------+--------------------------------+ | ? | search_entries | +-------------------+--------------------------------+ | ? | search_profiles | +-------------------+--------------------------------+ | Login | +-------------------+--------------------------------+ | ? | user_login | +-------------------+--------------------------------+ | Hits | +-------------------+--------------------------------+ | ? | get_hits_month | +-------------------+--------------------------------+ | ? | get_hits_popular | +-------------------+--------------------------------+ | Entries | +-------------------+--------------------------------+ | ? | get_entry | +-------------------+--------------------------------+ | ? | get_stream_entries | +-------------------+--------------------------------+ | ? | get_hot_entries | +-------------------+--------------------------------+ | Tag | +-------------------+--------------------------------+ | ? | get_tag | +-------------------+--------------------------------+ | ? | get_tags_observed | +-------------------+--------------------------------+ | ? | get_tag_entries | +-------------------+--------------------------------+ | ? | get_tag_links | +-------------------+--------------------------------+ | PM | +-------------------+--------------------------------+ | ? | get_conversations_list | +-------------------+--------------------------------+

? = nieudokumentowana metoda

Proste żądania ^^^^^^^^^^^^^^^^^^^

Implementacja API w wersji 2 również posiada podstawową metodę do tworzenia żądań. Na przykład:

link = api.request("entries", 'hot', {"period": 12})

gdzie:

+-------------------+-------------------------+ | 'entries' | typ zasobu | +-------------------+-------------------------+ | 'hot' | metoda zasobu | +-------------------+-------------------------+ | {"period": 12} | parametry API | +-------------------+-------------------------+

Zgłaszanie błędów

Jeżeli znalazłeś jakieś błędy lub masz inny problem zgłoś go na bugtracker_ lub na mirko @tenji :>

.. _bugtracker: https://github.com/p1c2u/wykop-sdk/issues

wykop-sdk
wykop-sdk copied to clipboard

Metadata

Wykop API Python SDK

Instalacja

Uwierzytelnienie

API wersja 1

API wersja 2

Zgłaszanie błędów

← Metadata

Owner

Metadata

wykop-sdk wykop-sdk copied to clipboard

Metadata

Wykop API Python SDK

Instalacja

Uwierzytelnienie

API wersja 1

API wersja 2

Zgłaszanie błędów

← Metadata

Owner

Metadata

wykop-sdk
wykop-sdk copied to clipboard