Stuweparser

This package contains a collection of functions to crawl and parse the website of the Studierendenwerk Tübingen-Hohenheim.

Getting Started

These instructions will get you a copy of the stuweparser package on your local machine. If you only want to use stuweparser as a python package use pip3 in order to install it into your python3 environment. If you want to inspect and change the code download and install it via git clone and python3 setup.py. For details see below.

Prerequisites

You need python 3.4 or newer and git installed on your machine. We recommend to install Minicoda (https://conda.io/miniconda.html) before installing stuweparser or to create a virtualenv within your personal folder.

Development

If you want to develop stuweparser you should additionally install:

pip3 install --user tox pylint pytest pycodestyle sphinx

Installing

If you want to use the package you can install the package by running

git clone https://github.com/trybnetic/stuweparser.git
cd stuweparser
python3 setup.py install

Documentation and Examples

Documentation and examples can be found in the doc/ folder after cloning the repository.

If you have installed sphinx you should be able to build the documentation with:

cd doc/
make html

The entry point for the html documentation is doc/build/html/index.html.

Running the tests

If you have cloned stuweparser from github, you can start the tests by executing the following within the outer stuweparser folder:

py.test

For full tests you can run:

tox -e test

For manually checking coding guidelines run:

pycodestyle stuweparser tests
pylint --ignore-patterns='.*\.so' --rcfile=setup.cfg -j 2 stuweparser tests

For more details on which tests run in the continuous testing environment look at the file tox.ini.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.txt file for details

Acknowledgments

This package originates from python scripts written by Steffen Lindner in his repository Mensa Tübingen App.