From 39900aaa275555d67bca4ec611980d3aafbb3a27 Mon Sep 17 00:00:00 2001 From: Jim Martens Date: Mon, 13 Jan 2020 23:22:55 +0100 Subject: [PATCH] Added changelog and use rST for README --- CHANGELOG.rst | 29 +++++++++++++++++++++++++ MANIFEST.in | 3 ++- README.md | 53 --------------------------------------------- README.rst | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 90 insertions(+), 54 deletions(-) create mode 100644 CHANGELOG.rst delete mode 100644 README.md create mode 100644 README.rst diff --git a/CHANGELOG.rst b/CHANGELOG.rst new file mode 100644 index 0000000..cc4223d --- /dev/null +++ b/CHANGELOG.rst @@ -0,0 +1,29 @@ +Changelog +========= + +This changelog contains a list of versions with their respective high-level changes. + +v0.3.2: + document links now work if more than three documents are available +v0.3.1: + - fixed URL for invited sessions + - fixed problems with headless mode for GUI-free systems +v0.3.0: + added support for multiple districts +v0.2.2: + - added support for official abbreviations of committees + - detects now all invited sessions, not only every other +v0.2.1: + - finally fixed regional committees +v0.2.0: + - fixed regional committees part one +v0.1.4: + unified versions between README and setup.py +v0.1.3: + corrected link to Git repository +v0.1.2: + added nice badges +v0.1.1: + added main module +v0.1.0: + - initial release diff --git a/MANIFEST.in b/MANIFEST.in index 04f196a..c2e4b1b 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,2 +1,3 @@ -include README.md +include README.rst include LICENSE +include CHANGELOG.rst diff --git a/README.md b/README.md deleted file mode 100644 index 0e34297..0000000 --- a/README.md +++ /dev/null @@ -1,53 +0,0 @@ -# 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.2](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) diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..4c0e759 --- /dev/null +++ b/README.rst @@ -0,0 +1,59 @@ +ALLRIS Scraper +============== + +.. image:: https://img.shields.io/pypi/l/twomartens.allrisscraper :alt: Apache Licence 2.0 +.. image:: https://img.shields.io/pypi/pyversions/twomartens.allrisscraper :alt: Supports Python 3.7 and 3.8 +.. image:: https://img.shields.io/pypi/v/twomartens.allrisscraper :alt: version 0.3.2 + +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`_ 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/ + +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)