diff --git a/.gitignore b/.gitignore index e2d304cb5396d81fabb74a64b247671fb27d87e9..46e5469eeaa0cdc2749a696de34e248d8efb6aa5 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,6 @@ +# virtual environment folder +venv + # vscode workspace .vscode @@ -26,4 +29,4 @@ tags # Coc configuration directory .vim -__pycache__/ \ No newline at end of file +__pycache__/ diff --git a/README.md b/README.md index 1f1e3c0a696a09f646a586a3a057e8653a2bcd3d..eb9045cac6157271c76721d9cb0a9ec7154c12af 100644 --- a/README.md +++ b/README.md @@ -1 +1,40 @@ # Repo for bachelor SOI-tool + +## Forutsetninger + +* `Python 3.7` +* `Pip 20.0` +* Windows 10 eller Ubuntu 18.04. Merk at flesteparten av gruppen arbeider på Windows 10 + +## Oppsett med virtual environment + +```bash +# initialiser virtual environment +python -m venv venv +# aktiver virtual environment (Windows) +./venv/Scripts/activate +# aktiver virtual environment (Ubuntu, ikke testet) +./venv/bin/activate +# sikre at venv har riktige versjoner av kritiske innebygde pakker +# (kanskje unødvendig) +# dette blir gjort fordi default gir pip-18, som gir errormeldinger. +# Se https://bugs.python.org/issue30628 +python -m pip install pip=='20.0' setuptools=='45.2' wheel=='0.34' +# installer pakker +pip install -r requirements.txt +# ...jobb med koden... +# for å deaktivere virtual environment +deactivate +``` + +## Linting + +*TODO* + +## Testing + +Tester er skrevet med `unittest` modulen, og ligger i mappen `test`. + +* For å kjøre alle tester: `python -m unittest` +* For å kjøre en enkelt test modul (fil i `test` mappen): `python -m unittest test.<navnet_til_modulen>` +* For å kjøre en enkelt test metode (fil i `test` mappen): `python -m unittest test.<navnet_til_modulen>.<navnet til klassen>.<navnet til metoden>`