Bevor du loslegst, stelle sicher, dass du Python 3.5 bzw. Python 3.5 installiert hast.
Dies kannst du machen, in dem du das Kommando python3 --version ausführst
$ python3 --version
Python 3.5.2PEP-8 ist der "Style Guide for Python Code". Er gilt für dieses Projekt. Wenn du einen Editor wie Atom, Sublime etc. brauchst, dann installiere bitte das entsprechende Plugin/Addon, welches den code auf PEP-8 prüft.
PEP-8 kann auch über die Kommandozeile geprüft werden - ist aber mühsamer in der Handhabung als direkt im Editor.
$ sudo pip3 install pep8
$ pep8 openhsr_connect/ tests/cd path/to/my/projects
git clone https://github.com/openhsr/connect.gitEin Virtualenv ist eine isolierte Python-Umgebung, damit wir bei der Entwicklung keine Konflikte mit global installierten Paketen haben.
Dazu müssen wir eine neue solche virtuelle Umgebung erstellen:
$ python3 -m venv venvDamit ist die einmalige Einrichtung abgeschlossen. Um das virtualenv zu aktivieren, muss folgendes Kommando ausgeführt werden, bevor man damit beginnt, am Projekt zu arbeiten.
$ source venv/bin/activateDie Prompt beinhaltet den Text (venv) - dadurch wissen wir, dass ein virtualenv aktiv ist.
Wenn du mit deiner Arbeit fertig bist, dann kannst du das virtualenv mit dem Kommando deactivate
deaktivieren
$ deactivateDie Abhängigkeiten des Projekts sind in der Datei requirements.txt aufgelistet. Abhängigkeiten, welche zur Entwicklung benötigt werden (wie bsp. Testframeworks) sind in der Datei requirements-dev.txt gelistet.
Die Installation mittels pep erfolgt wie folgt:
$ pip3 install -r requirements.txt
$ pip3 install -r requirements-dev.txtUm sowohl die Tests auszuführen, als auch die Kommandozeile testen zu können, muss das openhsr-connect Paket installiert werden:
o
$ pip install --editable .Als Testsuite brachen wir pytest. Alle Tests im Verzeichnis tests/ laufen zu lassen geht mit dem folgenden Kommando:
pytestund um die Testabdeckung zu sehen, kann der Parameter --cov angehängt werden:
pytest --cov