osl-incubator / makim

Make Improved
https://osl-incubator.github.io/makim/
BSD 3-Clause "New" or "Revised" License
8 stars 10 forks source link

Move from flat layout approach to src layout #61

Closed xmnlab closed 9 months ago

xmnlab commented 10 months ago

ref https://osl-incubator.github.io/scicookie/guide.html#project-layout

xmnlab commented 9 months ago

some discussions about this topic: https://github.com/osl-incubator/containers-sugar/issues/91

xmnlab commented 9 months ago

As you can see, there is no src folder. So, this is a flat layout, where typically source files are in a folder called with the same name of the package in the root of the project.

To convert that to src layout, basically:

  1. Create a src folder in the root of the project
  2. move makim to src
  3. Update pyproject.toml

Verify in the code any place that is using the path containers_sugar/ and replace by the new path

Some references:

xmnlab commented 9 months ago

completed by #63