get_article ( id,  api_key )

Holt Informationen von YiGG ueber einen Artikel. Zurueckgegeben wird ein Objekt vom Typ struktur.Article().

Aufruf: get_article(id, api_key) Rueckgabe: struktur.Article()

get_frontpage ( api_key )

Ein Wrapper fuer yigg.frontpage.all()

Es kann hiermit jedoch nur auf das REST-API zugegriffen werden...

get_story ( id,  api_key )

Ein Alias fuer get_article(). Fuer naehere Informationen siehe die Dokumentation von get-article().

Dieser Name entspricht dem "offiziellen" YiGG-API-Namen! (Er wird also vermutlich irgendwann zur "Hauptfunktion".

list_by_cat_pages ( cat_id,  api_key )

Siehe list_by_tag_pages. Man gibt jedoch statt einem Tag die ID einer Kategorie an!

list_by_category (
        cat_id,
        api_key,
        page=None,
        )

Aehnlich wie list_by_tag, man muss jedoch statt einem Tag die ID einer Kategorie angeben!

list_by_tag (
        tag,
        api_key,
        page=None,
        )

Erzeugt eine Liste mit allen Artikeln die mit einem bestimmten Tag getaggt sind.

YiGG teilt diese Liste auf mehrere Seiten auf, der optionale Parameter page ermoeglicht es eine bestimmte zu bekommen. Standard ist, dass nur die erste Seite zurueckgegeben wird. Wenn page den Wert "ALL" hat, werden alle Artikel zurueckgegeben. Achtung: Diese Liste kann vor allem bei viel genutzten Tags sehr lang sein.

Die erste Zahl in der Rueckgabeliste entspricht der Anzahl an Seiten die es gibt. Die zweite Zahl steht fuer die aktuelle Seite.

Aufruf: list_by_tag(tag, api_key, page=None) Rueckgabe: [int, int, Artikel...]

list_by_tag_pages ( tag,  api_key )

Gibt die Anzahl an Seiten zurueck die es gibt, wenn man die Liste an Artikel die einen bestimmten Tag haben will.

Aufruf: list_by_tag_pages(tag, api_key) Rueckgabe: int