Style and structure conventions?
When going through the code for the first time, I noticed the following irregularities, which could confuse/alienate potential contributors.
Of course, specific deviations from the rules may be reasonable, but in general contributors will appreciate a conventional style (especially in the python ecosystem).
Directory structure
The code is below the src/
directory, which is quite common for projects implemented in C or similar. Instead it is common for python-based projects (even applications) to arrange the layout of a python module. Here it could be aura_engine
. Thus imports would change from src.scheduling.models
to aura_engine.scheduling.models
.
Style
Currently the code is quite close to PEP-8, but it still contains quite a lot of issues (mainly due to whitespace or blank lines). flake8 is quite a common tool for verifying the style.
In addition black is a common tool for auto-formatting python code. It relieves developers from the chore of bike-shedding discussions by providing a widespread standard.
Progress
What do you think about these proposals?
I would be willing to prepare changesets for the two above topics (or just one, if there is no consensus on both).