Metadata-Version: 2.1
Name: wpath
Version: 0.0.8
Summary: package help find the project root folder.
Home-page: https://github.com/cofepy
Author: Aeneas
Author-email: kai.he@taraxa.io
License: MIT
Keywords: project root folder workspace
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown

# wpath

wpath: a package help you find the project workspace

## Install
```
git clone https://github.com/cofepy/wpath
cd wpath
python setup.py install
```
or
```
pip install wpath
```
## Env file

add one of flags [".env",".gitignore",".git","package.json"]  into your project workspace.

## Useage

``` python
import wpath
# this will add your workspace to python path
# by default, wpath will search parent folder which has an '.env' file as workspace flag

# show project workspace, 
# if not found the flag, wpath.workspace() will return None
print(wpath.workspace())

# change default flag
wpath.reset(['.gitignore'])
print(wpath.workspace())

```

