Improve README

[buhtz]

I found an ITP on the debian-python list about your project.
Sorry, I don't understand all details.

Can you improve your README and explain a bit more detailed what the package does and what the advantage is here. Currently I don't see an advantage.

I only see very simple path handling which could be done by or via pathlib itself also. What does your package add to the pathlib functionality?

[jamesmyatt]

It brings these techniques to Python:

• https://www.tidyverse.org/blog/2017/12/workflow-vs-script/
• https://cran.r-project.org/web/packages/here/vignettes/here.html

[buhtz]

Sorry, I don't get it. I don't find it complicated but pretty simple.

The project folder is very the py-file is. Or when you store your py files on sub-folder done in your project folder to ../data/file.csv or something like that.

It is easier to understand if you would create an example and show the tree output. Maybe than it becomes clearer.

[jamesmyatt]

Best practice is to store the data files and notebooks/script files in separate directories, e.g. https://drivendata.github.io/cookiecutter-data-science/. For example, you might also use sub-directories within the "notebooks" directory to further organise the notebooks by purpose.