Metadata-Version: 2.1
Name: rootfoldersearch
Version: 0.0.1
Summary: This package finds the root directory of a project by traversing the ancestors directories starting at a given path.
Home-page: https://github.com/jlcastillo/rootfoldersearch
Author: jlcastillo
Author-email: 
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.0
Description-Content-Type: text/markdown

# Root Folder Search

This package finds the root directory of a project by recursively traversing parent directories starting at a given path.

I used it to overcome a limitation in Jupyter Notebooks, that doesn't provide the `__file__` variable that would let me easily find the root folder of a project, regardless the current working directory. You might find it useful in other scenarios.

# How to use

```
import rootfoldersearch

# returns a string with the absolute path to the root folder, where Readme.md is located
rootfoldersearch.findpath('Readme.md')

# the same, but using a file in a subfolder as reference to find the root directory
rootfoldersearch.findpath('/util/a-file')

# the same, but only tries 3 parent folders recursively (default is 10)
rootfoldersearch.findpath('Readme.md', depth=3)
```


