Appropriate folder structure of the Python package

[alphaville]

Motivation

The end-user should be able to install and use this package easily, by doing just

pip install .

What needs to be done

The folder structure of the Python project should be:

- setup.py
- VERSION
- MANIFEST.in
- README.md
deadcopter/
  L flight_controller/
      L __init__.py (1)
  L jinja_templates/
  L test/
  L __init__.py (2)

We need

• a setup.py file (in which we should exclude test) and the auxiliary files VERSION and MANIFEST.in; the setup.py should list the dependencies; we have pyquaternion, scipy and control I think
• rename src to deadcopter (it should be the name of the Python package)
• the file __init__.py in (1) should not use import but rather:

from .copter import *
from .jinja_create import *
from .simulator import *

• the file __init__.py (2) should not be empty, but should load the submodules of the project

See also

OpEn