Go to file
Jim Martens 3f5ae9ad34 Added info about firefox binary to README 2020-06-05 17:23:56 +02:00
docs Added rudimentary documentation 2020-01-14 07:55:42 +01:00
src/twomartens Added headless option which mysteriously disappeared 2020-06-05 17:21:17 +02:00
.gitignore Create config file automatically if missing 2020-01-07 08:07:27 +01:00
CHANGELOG.rst Bumped version number 2020-06-05 17:21:57 +02:00
LICENSE Initial commit 2020-01-06 22:10:14 +01:00
MANIFEST.in Added rudimentary documentation 2020-01-14 07:55:42 +01:00
README.rst Added info about firefox binary to README 2020-06-05 17:23:56 +02:00
pyproject.toml Added support for modern python build system 2020-01-13 08:27:28 +01:00
setup.py Bumped version number 2020-06-05 17:21:57 +02:00

README.rst

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.3.5

This scraper 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.

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

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)