Task: restructure repository

[jrihon]

🥅 Objective

• https://packaging.python.org/en/latest/tutorials/packaging-projects/
• Move all assets to the correct directory

my_project/
├── src/
│   └── my_package/
│       ├── __init__.py
│       └── main.py
├── resources/           <-- Or place inside your package
│   └── data.json
├── config.yaml          <-- Or config.env
└── pyproject.toml       <-- Dependencies & Metadata

Using the pathlib library, we would do like so :

from pathlib import Path

# Points to the directory of the current file
current_dir = Path(__file__).parent
asset_path = current_dir.parent / "resources" / "data.json"

with open(asset_path, "r") as f:
    print(f.read())

📋 Todo List

Granular steps to finish the task

• Repository structured like an actual python package
• assets / resources restructured in a way they are part of the source
• removal of shell script and ducquehome variable

🧪 Tests

When the package is easily installable and the resources are located correctly.