By Request: How to Layout a Python Project

[john-science]

This lecture is a request to understand:

• How to build / layout a Python project.
• How to build a namespace in the code ("to fix relative imports").
• How to make the code an installable library (setup.py or pyproject.toml).

As such, I think we could do this by example:

• myProject/
  • pyproject.toml
  • myProject/
  • module1/
    • __init__.py
    • thing.py
  • module2/
    • __init__.py
    • what.py
    • tests/
    • __init__.py
    • test_module2.py

I think all I need is a solid idea for a simple two module project to work on.

[john-science]

There is a version of this lecture here:

https://github.com/john-science/python_for_scientists/blob/main/classes/19_building_projects/lecture_19.md

But I guess it needs to be flushed out.

And it definitely needs to be updated to use pyproject.toml.

[john-science]

We could mention the pyproject.toml solution presented is best for Python 3.9+.

[john-science]

Finished!