Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ashleve committed May 22, 2022
1 parent 92daf63 commit d3e9e4a
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@

[![Tests](https://github.com/ashleve/pyrootutils/actions/workflows/tests.yaml/badge.svg)](https://github.com/ashleve/pyrootutils/actions/workflows/tests.yaml)

A simple python package to solve all of your problems with pythonpath, working directory, file paths, module imports and environment variables.
A simple python package to solve all your problems with pythonpath, working directory, file paths, module imports and environment variables.

## Why pyrootutils?

**Problem:** I would like to be able to:

- run my python scripts from anywhere
- always import python modules relatively to the project root directory
- always access files relatively to the project root so I don't have to specify a series of `../` to get to the data
- always have access to environment variables from `.env` file without having to load them manually
- have all of the above benefits in notebooks even if they're nested in subdirectories
- Run my python scripts from anywhere
- Always import python modules relatively to the project root directory
- Always access files relatively to the project root so I don't have to specify a series of `../` to get to the data
- Always have access to environment variables from `.env` file without having to load them manually
- Have all the above benefits in notebooks even if they're nested in subdirectories

**Solution:** The `pyrootutils` package provides a flexible way to setup the python project with a simple one-liner. It finds the project root based on the location of specified file name, e.g. `.project-root` or `.git`.

The package is really tiny and throurougly tested with continuous integration, so you can use it safely without worrying it gets deprecated.
The package is tiny and continuosly maintained, so you can use it without worrying it gets deprecated in the future.

## Setup

Expand Down

0 comments on commit d3e9e4a

Please sign in to comment.