Skip to content

A Python 2.x / 3.x equivalent of R's here package - trivial relative paths for python data science / analysis projects.

License

Notifications You must be signed in to change notification settings

wildland-creative/pyhere

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

44 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

pyhere

Build Status Latest pypi version

A Python 2.x / 3.x equivalent of R's here package, drawing inspiration from chendaniely's pyprojroot package, but more closely mirroring the functionality within R's here. Relative file referencing has never been easier!

For complete information, check out the docs.

Installation

pip

You can install the latest stable version with pip via:

pip install pyhere

And if you want to be on the bleeding edge of development, get the latest version from github:

pip install --editable=git+https://github.com/wildland-creative/pyhere.git#egg=pyhere

conda

Not in conda - just install it from pip in your environment.

Usage

from pyhere import here

relative_dirA = here("your", "relative", "directory", "file.txt")
relative_dirB = here("your/relative/directory/file.txt")

pyhere uses simple heuristics to find a project's root directory. From Path.cwd(), it traverses upwards, looking for a possible root_indicator:

root_indicators = [
    ".here",
    "requirements.txt",
    "setup.py",
    ".vscode", # vscode project
    ".idea", # pycharm project
    ".git",
    ".spyderproject", # spyder
    ".spyproject", # spyder
    ".ropeproject" # rope
]

When found, it joins the arguments passed to here() to the rootpath and returns as a Path object. If it reaches the system root, it returns the system root and throws a warning.

For a concrete example, imagine the following directory structure:

\project\src\script.py
\project\data\data1.csv
\project\.here

If you call

data = here("data", "data1.csv")

from script.py, you'll get a Path object representing \project\data\data1.csv.

Changelog

Changelog is over here.

About

A Python 2.x / 3.x equivalent of R's here package - trivial relative paths for python data science / analysis projects.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages