Skip to content

Latest commit

 

History

History
63 lines (47 loc) · 1.38 KB

README.md

File metadata and controls

63 lines (47 loc) · 1.38 KB

Module wordish

Function to reveal the math attributes from arbitrary text

Quick start

Setting up the environment

Using Anaconda, open the Anaconda Prompt and run the command:

conda env creeate -n wordish -f env_file.yaml

Activate the environment using the command:

conda activate wordish

Then, run the environment by typing:

python -m wordish.main --file wordish\text_sample.txt

NB! Make sure to write the correct path! In your favorite IDE choose the newly created python environment.

Code development

For further development the following methods are practical

In tasks.py different utility function are defined for code style, formatting, syntax and tests.

Pycodestyle

In terminal window run pycodestyle using:

invoke style

Correct the code according to the output.

Pylint

In terminal window run pylint using:

invoke lint

Correct the code according to the output.

Unit tests

In terminal window run unit tests using:

invoke unit-tests

(NB! The underscore becomes a dash when calling the function.)

Important to isolate each test to its input and output reference frame using mocking functionality.

Coverage should aim for 100%.

Integration tests

In terminal window run integration tests using:

invoke unit-tests

Coverage should aim for 100%.