Metadata-Version: 2.1
Name: twomartens.allrisscraper
Version: 0.3.1
Summary: Scraper for ALLRIS
Home-page: https://git.2martens.de/2martens/allris-scraper
Author: Jim Martens
Author-email: github@2martens.de
License: Apache License 2.0
Description: # ALLRIS Scraper
        
        ![Apache Licence 2.0](https://img.shields.io/pypi/l/twomartens.allrisscraper)
        ![Supports Python 3.7 and 3.8](https://img.shields.io/pypi/pyversions/twomartens.allrisscraper)
        ![version 0.3.1](https://img.shields.io/pypi/v/twomartens.allrisscraper)
        
        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 committe abbreviations will only work for
                       Eimsbüttel as of now.
        
        ## Requirements
        
        - Python 3.7+
        - Firefox installed
        - [geckodriver binary][0] in PATH
        
        [0]: 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
        
        ```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/
        ```
        
        ## 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)
        
Platform: UNKNOWN
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Environment :: Console
Classifier: Topic :: Utilities
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: ~=3.7
Description-Content-Type: text/markdown; charset=UTF-8
