Improve "src" folder structure (namespace)

Engine and Engine API is applying the "newish traditional" source folder pattern, where all the source code is located in src. See this comment for reference.

Current implementation

All source code is already located in src.

Expected implementation

Source code should be nested in some additional package named after the project-name. For example src/engine and src/engineapi. As per PEP-8 underscores should be avoided, if possible.

The namespace for import statements in contrast should only require the engine prefix, like engine.foo.bar. Not having src part of the namespace.

changed milestone to %1.0-alpha2 — Precise Pheasant

added P2 label

assigned to @sumpfralle

marked this issue as related to #94 (closed)

mentioned in issue #94 (closed)

I guess, we should not use the generic term engine as the top level package name (e.g. the name is already squatted in pypi). How about aura_engine (despite the underscore being discouraged) or auraengine?

Makes sense.

Being a visual person I find both not too beautiful. Especially in case of the API it would be auraengineapi. So I tend a bit more to the version with underscores, which PEP-8 discourages.

--> But please feel free to choose for yourself. I will adjust to both variants

Another last minute thought: Would it be valid to occupy the aura namespace only, when defining the top level package? Keep in mind there's is also a Python module named engine.py. So imports would look like aura.engine.* which feels most appealing to me (visually speaking).

added To Do label

changed title from Improve "src" folder structure to Improve "src" folder structure (namespace)

removed the relation with #94 (closed)

marked this issue as related to #94 (closed)

marked this issue as related to #96 (closed)

assigned to @david and unassigned @sumpfralle

added 1 deleted label

added Doing label and removed To Do label

mentioned in commit 5f779151

mentioned in commit acec5f51

mentioned in commit 475adc05

closed

removed Doing label