Metadata-Version: 2.1
Name: pathnav
Version: 1.2.0
Summary: Naviagte paths with ease
Home-page: https://github.com/titushm/pathnav
Download-URL: https://github.com/titushm/pathnav/archive/refs/heads/main.zip
Author: TitusHM
Author-email: TitusHM <dev.titushm@gmail.com>
License: Mozilla Public License 2.0
Project-URL: Homepage, https://github.com/titushm/pathnav
Project-URL: Bug Tracker, https://github.com/titushm/pathnav/issues
Keywords: path,navigation,path edit
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.5
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: LICENSE.txt

# pathnav
Navigate paths with ease for python

# Docs
## Install pathnav
`pip install pathnav`
## Create new path object
```py
import pathnav

path = pathnav.path("C:\Users\titushm\Repos\Github") # create a directory path object

# Properties
print(path.path) # get the path as a string
print(path.dir_name) # get the name of the directory
print(path.child_dirs) # get a list of directorys in the directory
print(path.child_files) # get a list of files in the directory
print(path.dir_size) # get the size in bytes of the directory

# Methods
print(path.up()) # go up one directory
print(path.into("example-repo")) # go down one specified directory
print(path.get_file("text-file.txt")) # get a file by name in the directory

path = pathnav.path("C:\\Users\\titushm\\Repos\\Github\\test-file.txt") # create a file path object

# Properties
print(path.path) # get the path as a string
print(path.file_name) # get the file name as string
print(path.file_type) # get the file type as a string
print(path.parent_dir) # returns a directory path object for the directory that the file is in
```
