worldbank / GOSTnets

Convenience wrapper for networkx analysis using geospatial information, focusing on OSM
https://worldbank.github.io/GOSTnets/
MIT License
21 stars 15 forks source link

Remove the src/ directory? #55

Closed elbeejay closed 5 months ago

elbeejay commented 5 months ago

@g4brielvs wanted to ask about this - why do we nest the GOSTnets directory within src?

Was just noticing locally that my builds from pyproject.toml automatically create a GOSTnets subdirectory within the root repository and that's where the autogenerated _version.py file is placed, which makes me think the pyproject setup is expecting the GOSTnets directory to sit directly beneath the repo root.

g4brielvs commented 5 months ago

@elbeejay Thank you for bringing up thi point regarding the structure of the project and the placement of the GOSTnets directory within a src directory. The decision to nest the GOSTnets directory within src is indeed intentional and aligns with several (opiniated) best practices in Python project development.

A discussion thread has been created to engage the community on this and I'm eager to hear your thoughts.