Use standard file naming and layout

panahiparham / ml-experiment-definition

MIT License

2 stars 3 forks source link

Use standard file naming and layout #13

Closed yasuiniko closed 1 week ago

yasuiniko commented 2 weeks ago

Some reorganization that I think would help

[ ] ~~./src/ml_experiment/... instead of ./ml_experiment/... This is the default that is expected by pytest and setuptools.~~
[ ] part_definition.py instead of PartDefinition.py. This avoids confusion between module names and class names — does tests/test_PartDefinition.py test PartDefinition.py, or the PartDefinition class?
```
from ml_experiment import PartDefinition

my_part_definition = PartDefinition.PartDefinition()
```

panahiparham commented 2 weeks ago

@andnp what do you think?

andnp commented 1 week ago

Strong agree on the second. Unsure about the first. I believe that standard practice for python libraries is that source code is located in <library_name>/*.py

yasuiniko commented 1 week ago

That works for me! I removed the task about the folder structure to focus on the renaming.