Metadata-Version: 2.1
Name: getpaths
Version: 1.0.0
Summary: Pathing Library
Home-page: https://pypi.org/project/getpaths/
Author: Jv Kyle Eclarin
Author-email: <jvykleeclarin@gmail.com>
License: UNKNOWN
Project-URL: Documentation, https://pypi.org/project/getpaths/
Project-URL: Code, https://github.com/mathemusician/getpath
Project-URL: Issue tracker, https://github.com/mathemusician/getpath/issues
Keywords: python,pathing,path,getpath
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Education
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Description-Content-Type: text/markdown
License-File: LICENSE

# getpath
Helps with pathing in python scripts. Inspired by pathlib.

# IMPORTING
```
from getpaths import getpath
```

# USING CURRENT FILE PATH
```
current_dir = getpath() # current file's path
```

# USER-SPECIFIED PATH
```
custom_dir = getpath('a','b',custom=True)
print(custom_dir)
# /a/b
```

# ADD FILES
```
custom_dir/'example.txt'
# /a/b/example.txt

custom_dir.add('/a/example.txt')
# /a/b/example.txt
```

#  GO UP THE DIRECTORY
```
custom_dir = getpath('a','b',custom=True)

custom_dir/'..'
# /a

custom_dir.add('..')
# /a

custom_dir.up(1)
# /a
```

# LIST EXISTING FILES AND FOLDERS
```
custom_dir.ls()
# /a/b/example.txt
# throws error if path does not exist
```

