therepy 0.0.1

Therapeutic filepath management for python data projects.

therepy

A simple r-lib/here for python, to make file path management less of a headache in project-oriented workflows.

Installation

pip install therepy

See pypi for details

Overview

R's here library uses the .Rproj file to identify the top-level or root directory in an R project, and all file paths are defined relative to this directory.
Instead of looking for a specific file or file extension, the therepy module has the user define the root directory somewhere ("there", if you will):

from therepy import Here
here = Here("myproj")

Once initialized, the Here object allows you to specify file paths relative to the defined root directory (in this example, "myproj"), since it coverts them to absolute paths under the hood.
For example, if I have a dataset in a subfolder, "myproj/database/data.csv", and I want to use it in a script, "myproj/analysis/viz.py", I can specify the path like so:

# -- viz.py -- 
fp = here.here("database", "data.csv")
print(fp)
#> PosixPath("/home/user/Documents/myproj/database/data.csv")
df = read_csv(fp)

The relative paths are expanded into absolute paths, so the returned file path will work even if "viz.py" gets moved around.

If you do not want to use your project's folder name to initialize Here, you can provide the name of a file that exists in your project's root or a glob style expression identifying such a file:

here = Here(".git")
here = Here("*.Rproj")

Here is built on pathlib and returns pathlib.Path instances by default (a PosixPath or WindowsPath depending on your system).
This allows you to take advantage of pathlib's great features, like:

here = Here("myproj")
fp = here.here("database/data.csv")
if fp.exists():
    ... 

And since pathlib can resolve and join paths, you can easily define folders for reading and writing to:

here = Here("myproj")
outputs = here.here("outputs")
print(outputs)
#> PosixPath("/home/user/Documents/myproj/outputs")
...

df.to_csv(here.here(outputs, "data.csv"))

Here will return strings if you ask it too:

here = Here("myproj")
print(here.here(as_str=True))
#> "/home/user/Documents/myproj"