3. Running text script

This section is for developers as users will be running the released versions and not the development version. It goes without mentioning that you should clone the repository before trying the following steps.

From Console:

1. Install the dependencies, preferably in a virtual environment, then activate the virtual environment.
2. Change the directory to textscript within your repository.
3. Run the text-script.py file:

python text-script.py

Note: This program is sensitive to the current working directory. It is not recommended to run this program from another CWD at this time until appropriate checks have been implemented.

From an IDE:

1. Install the dependencies, preferably in a virtual environment, then activate the virtual environment.
2. Change the configuration in your IDE so that textscript is both marked as sources root, and as the current working directory when you run files within it.
3. Run the text-script.py file ensuring it is ran from the correct CWD.

Note: If the program creates duplicate folders in the wrong directory, it is being ran from the wrong the wrong CWD.