DHI / DHI/python-package-development
File structure
- Dominant language
- Jupyter Notebook
- Stars
- 8
- Forks
- 1
- Avg merge
- 4m
- Merged PRs (30d)
- 1
Description
* Add a suggested file structure and the connection to modules and import resolution.
* [src layout vs flat layout](https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/)
* What belongs in a module level `__init__py`, should it be empty?
* Consider if placing the tests inside the modules make sense (see e.g. https://github.com/scikit-learn/scikit-learn/tree/main/sklearn/ensemble)

Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the linked Python Packaging User Guide discussion and the scikit-learn ensemble tree to compare src and flat layouts and test placement. Done means the course documents a recommended file structure, its module and import-resolution relationship, guidance for module-level __init__.py files, and a position on placing tests inside modules.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100