Welcome to TWCManager development, and a very big thank you for your contribution to the project. This guide is intended to kick-start development efforts by acting as a knowledgebase for useful details about developing for TWCManager.
The easiest way to maintan and test a TWCManager source tree is to run the TWCManager.py script directly from the repository directory. For example:
git clone https://github.com/ngardiner/TWCManager
cd TWCManager
This is your working branch of the repository.
./TWCManager.py
Python dependencies are documented in the setup.py script.
Currently, there are inconsistent debug levels used throughout the project. This has been flagged as a high priority area of improvement. The following tables aim to clarify
| Debug Level | Used for |
|---|---|
| 1 | Notification to users, initialization messages and errors |
| 1 | Confirmation of policy selection |
| 2 | Internal error/parameter issue eg missing value for internal function call |
| 7 | Policy selection, module loaded |
| 8 | Policy parameter comparison and non-selection of policy |
| 10 | Loop entry, loop exit debugs |
| 11 | Developer-defined debug checkpoints/output/etc |
| Debug Level | Used for |
|---|---|
| 1 | Critical error which prevents module functionality (eg. not configured / incorrect config |
| 10 | Loop entry, loop exit debugs |
| 11 | Developer-defined debug checkpoints/output/etc |
The values which are stored in the config and settings dicts are interpreted from JSON storage after each restart. This can cause an issue, in that whilst they are a true representation of the data