README.rst

   1 Leśmianator
   2 ===========
   3
   4 To jest przykładowy projekt, który mógłby wystartować
   5 w `Turnieju Elektrybałtów <http://turniej.wolnelektury.pl>`_. Jest napisany
   6 w Pythonie, ale kluczowe elementy (zwłaszcza sposób dostępu do utworów
   7 źródłowych w skryptach ``init-*.py``) powinny być zrozumiały również bez
   8 znajomości tego języka.
   9
  10 Projekt zawiera właściwy program generujący wiersze (``lesmianator.py``)
  11 i skrypty inicjalizujące (``init-*.py``) korzystające z różnych metod
  12 dostępu do źródłowych utworów (API Wolnych Lektur, paczka z plikami TXT,
  13 paczka z plikami XML). Zgłaszając się do Turnieju Elektrybałtów, wystarczy
  14 oczywiście wybrać jedną z tych metod.
  15
  16
  17 Zależności
  18 ----------
  19
  20 * Python 2.7
  21 * Librarian (https://github.com/fnp/librarian)
  22
  23
  24 Sposób użycia
  25 -------------
  26
  27 Przed uruchomieniem Leśmianatora konieczne jest przeanalizowanie utworów
  28 źródłowych przy pomocy jednego ze skryptów ``init-*.py``.
  29
  30 * ``init-api.py`` analizuje sonety Adama Mickiewicza, pobierając pliki tekstowe
  31   za pośrednictwem `API Wolnych Lektur <http://www.wolnelektury.pl/api>`_.
  32 * ``init-txt.py`` analizuje wszystkie utwory liryczne, pobierając paczkę ZIP
  33   z plikami tekstowymi.
  34 * ``init-xml.py`` analizuje wszystkie wiersze, pobierając paczkę ZIP
  35   z plikami XML i przetwarzając je za pomocą
  36   `librariana <https://github.com/fnp/librarian>`_.
  37
  38 Skrypt inicjalizacyjny zapisuje wyniki analizy utworów w pliku ``data.p``.
  39
  40 Na podstawie tych danych ``lesmianator.py`` generuje wiersz i wypisuje go
  41 na standardowe wyjście.
  42
  43
  44 Autorzy
  45 -------
  46
  47 * Radek Czajka <radoslaw.czajka@nowoczesnapolska.org.pl>