autoroot

Automatic project root setup with just one import!

You only need to create empty .project-root file in the chosen directory.

Installation

pip install autoroot
pip install autorootcwd

Usage

# this adds root folder to pythonpath, sets PROJECT_ROOT var, and loads variables from `.env`
import autoroot

Or:

# this also changes working directory to root
import autorootcwd

That's it! You're done. One import is enough.

How it works

Adding the import autoroot to top of your python script will make a call to pyrootutils.setup_root(), which recursively searches for .project-root file in parent dirs to determine which folder is root.

See pyrootutils for more info:
https://github.com/ashleve/pyrootutils

Works in notebooks too.

Note: When importing autoroot in python script, the search is always started from folder containing the script that you launched. When importing autoroot in notebook, the search is always started from current working directory (I didn't find a way to determine placement of notebook).

Note: There might exist some edge cases where this package doesn't find the root. Please let me know if you find any!