Travel any path and find some files.
Project description
Travel any path and find some files
path-traveler
is a simple package to walk and travel from any root path directory into all of its children directories and files coming in the journey and perform search operation to list down all available path(s) of the file(s).
Use in python code
Following are some of the sample examples to show the use of the path-traveler
package. This package has a function named travelling
which takes optional input 2 arguments. root_path
is the first argument used to set the root directory path and find
is the second argument used to search any file in the root directory and all of its children directories. The default is None
which searches all files from root_path
. Let's take a look.
>>> from path_traveler import travelling
>>> root_path = './sample'
>>> find = 'spec.json'
>>> journey = travelling(root_path=root_path, find=find)
>>> journey._fields
('root_path', 'cwd', 'absolute_paths', 'relative_paths', 'travel')
>>> root_path = journey.root_path
>>> current_working_directory = journey.cwd
>>> absolute_paths = journey.absolute_paths
>>> relative_paths = journey.relative_paths
>>> traveller = journey.travel
Use in command line interface (CLI)
path_traveler --help
Usage: path-traveler [OPTIONS]
Options:
-P, --root_path TEXT Any path from which you want to start
travelling. If None is given then the root
directory of this module will act as root
path. The default is None.
-F, --find TEXT Find any file name which you want to
identify no matter whether is it present in
any of the subdirectories. If None is given
all find will be searching. The default is
None.
-A, --show_absolute_paths BOOLEAN
Print absolute paths [default: (False)]
-R, --show_relative_paths BOOLEAN
Print relative paths [default: (False)]
-E, --show_examples BOOLEAN Print predefined examples [default:
(False)]
--help Show this message and exit.
For more information please visit GitHub
License
MIT License
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for path_traveler-0.0.6-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3c75f3bafe5769bd312ad711b9dcd483fab08245b25f3ba1ba70e9ef5a032401 |
|
MD5 | 33451a5dae5ae543ad663919eb76a907 |
|
BLAKE2b-256 | d5091cd81908fad66ca8cd1a1a889865b29e8d70cf234dba0d8d780648545a7e |