Skip to content

Commit d3e9e4a

Browse files
committed
Update README.md
1 parent 92daf63 commit d3e9e4a

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,21 @@
22

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

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

77
## Why pyrootutils?
88

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

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

1717
**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`.
1818

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

2121
## Setup
2222

0 commit comments

Comments
 (0)