ALLRIS Scraper
==============

.. image:: https://img.shields.io/pypi/l/twomartens.allrisscraper.svg
    :alt: Apache License 2.0
.. image:: https://img.shields.io/pypi/pyversions/twomartens.allrisscraper.svg
    :alt: Python 3.7 and 3.8
.. image:: https://img.shields.io/pypi/v/twomartens.allrisscraper.svg
    :alt: version 0.5.9

This scraper offers both public and private scraping. The latter requires your username and password and performs the
following tasks for you:

- login
- download of all agendas and motions related to upcoming meetings of committees and plenary sessions

  - Only considers meetings where you already have been invited formally through ALLRIS.

**IMPORTANT:**
All districts are supported but official committee abbreviations will only work for Eimsbüttel as of now.

The public scraper ought to be used with care as it accesses all accessible pages of an entire month. Currently,
June 2020 is hardcoded and it can only be used in a GUI environment.

Requirements
------------

- Python 3.7+
- Firefox installed
- `geckodriver binary`_ in PATH

.. _geckodriver binary: https://github.com/mozilla/geckodriver/releases

Initial setup
-------------
1. Install ALLRIS scraper ``pip install twomartens.allrisscraper`` (you need Python 3.7+)
2. Run ALLRIS scraper a first time ``tm-allrisscraper`` (creates config ini in your current working directory)
3. Fill out the config file with your login credentials and an absolute path on your system to store PDFs of files

Configuration
-------------

.. code-block:: ini

    [Default]
    ; possible values for district: Altona, Bergedorf, Eimsbüttel, Hamburg-Nord,
    ; Hamburg-Mitte, Harburg, Wandsbek
    district = Eimsbüttel
    ; if you are not from Eimsbüttel your domain ending will differ
    username = max.mustermann@eimsbuettel.de
    ; password is stored in clear text, therefore ini file should have most
    ; restrictive read permissions
    password = VerySecurePassword
    ; location for storage of PDFs (trailing slash is IMPORTANT)
    pdflocation = /path/to/storage/of/PDFs/
    ; location of the firefox binary
    firefoxBinary = /Pfad/zur/firefox.exe
    ; location of the geckodriver binary
    geckodriver = /Pfad/zum/geckodriver

Usage after initial setup
-------------------------

Run ALLRIS scraper: ``tm-allrisscraper`` (takes a few seconds to finish)

In the specified location for download you will find the following structure:

- ``YYYY-MM-DD_Abbreviation of committee or plenary session/`` (one directory for each meeting)
- files inside the directory:
  ``Einladung.pdf`` (contains invitation), ``Mappe.pdf`` (contains all motions in one document), and ``Tagesordnung.pdf`` (agenda)

Packaging new versions
----------------------

Activate virtual environment and run ``python -m build --sdist --wheel``