Reorganize Project Structure for Improved Maintainability

[dwikler]

As the project has grown and evolved, its structure has become a bit mixed. The current structure combines CLI tools, UI applications, and libraries within one folder. As a result, some files are using the same filename in subfolders, with similar goal but different contents, some configuration files are duplicated. Progressively restructuring the project with separation of concern would improve maintainability and extensibility.

[dwikler]

Here are 2 options we can discuss:

option 1

tdwii-plus-examples/
├── cli/
│   ├── wrklstmgr.py
│   └── watchwrkitem.py
├── apps/
│   ├── rtbdi_creator.py
│   └── tdd.py
├── conf/
│   ├── default.ini
│   └── known_ae.json
├── doc/
│   ├── cli.md
│   └── apps.md
├── tdwii_plus_examples/
│   ├── __init__.py
│   ├── basescp.py
│   └── echoscp.py
├── pyproject.toml
└── README.md

option 2

tdwii-plus-examples/
├── tdwii_plus_examples/
│   ├── __init__.py
│   ├── basescp.py
│   ├── echoscp.py
│   ├── cli/
│   │   ├── wrklstmgr.py
│   │   └── watchwrkitem.py
│   ├── apps/
│   │   ├── rtbdi_creator.py
│   │   └── tdd.py
│   ├── conf/
│   │   ├── default.ini
│   │   └── known_ae.json
│   └── doc/
│       ├── cli.md
│       └── apps.md
├── pyproject.toml
└── README.md

Notes: Poetry usually uses underscores for package folder when project name contains dashes

[sjswerdloff]

I agree that the file structure needs reorganising. I prefer option 2 vs option 1, but I think having a library directory that contains the reusable (and already reused) modules would be helpful.

[dwikler]

Let's go for option 2 then 👍 I can start by duplicating the BaseSCP class from TDWII_PPVS_subscriber to the tdwii_plus_examples package folder and refactor the apps to use it, then make my way down the hierarchy of SCP classes.

[dwikler]

I have created the pull request (#86) that refactors BaseSCP. I will continue with its subclass EchoSCP.

[dwikler]

The previous pull request (#87) refactored EchoSCP in CEchoSCP

A new pull request (#88) refactors its subclass StoreSCP in CStoreSCP
The next step is to refactor its subclass NEventReceiver