Pakkaus-tira

Tiralabra 2021 Syksy

Documentation

Ohjelmaa vaatii Pythonin. Itselläni käytössä on Python 3.10.0, mutta ohjelman pitäisi toimia ainakin versiolla 3.7. Ohjelma voidaan suorittaa komennolla python -m pakkaus.
Testit voidaan suorittaa komennolla python -m unittest. Testikattavuuteen käytetään moduulia pytest-cov, ja tyyppitarkastukseen käytetään mypy-moduulia. Koodin laatua voidaan tarkkailla moduulilla pylint, mutta pylint on usein erittäin tarkka, ja kaikki koodi on jo formatoitu black-työkalulla.

Hyvä tapa asentaa molemmat on tehdä uusi virtuaaliympäristö python -m venv env ja aktivoida se. (Linux Bash: source env/bin/activate ja Windows env/Scripts/Activate.ps1) Tämän jälkeen tarvittavat pakkaukset voidaan asentaa komennolla pip install -r requirements.txt Testikattavuus saadann komennolla pytest --cov-report term-missing --cov=pakkaus tests/, laadun tarkastus komennolla pylint pakkaus ja tyyppitarkastus komennolla mypy pakkaus.

Ohjelman käyttö on yksinkertaista komennolla: python -m pakkaus (huffman|lzw) (pakkaa|pura) tiedostonimi kohdetiedostonimi. Esimerkiksi komento python -m pakkaus huffman pakkaa tiedosto.txt tiedosto.txt.lzw pakkaa tiedosto.txt:n tiedostoon tiedosto.txt.lzw.

• Määrittelydokumentti

• Testausdokumentti

• Toteutusdokumentti

Viikkoraportit

• Viikko 1

• Viikko 2

• Viikko 3

• Viikko 4

• Viikko 5