Recursivly walk and find files
Project description
Walkmate
Recursivly walk and find files
Status
Source | Shields |
---|---|
Project | |
Publishers | |
Downloads | |
Raised |
Installing
To install the package from pypi:
pip install walkmate
Alternatively, you can clone the repo and build the package locally.
Usage
Given a multi-level directory structure:
├── one.py
├── two.py
├── child/
│ ├── three.py
We can list all child files:
>>> list(get_child_files(root=".", maxdepth=2))
["/one.py", "/two.py", "/child/three.py"]
We can also search for a specific filename:
>>> list(get_child_files(root=".", maxdepth=2, match_name="three.py"))
["/child/three.py"]
Docs
Additional details are available in the full documentation.
To generate the documentation locally:
multi-job docs
Tests
Unit tests and behaviour tests are written with the pytest framework.
To run tests:
multi-job tests
Additionally, an html report will be saved to the local directory.
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.
Versioning
SemVer is used for versioning. For a list of versions available, see the tags on this repository.
Bump2version is used to version and tag changes. For example:
bump2version patch
Releases are made on every major change.
Author
- Joel Lefkowitz - Initial work - Joel Lefkowitz
See also the list of contributors who participated in this project.
License
This project is licensed under the MIT License - see the LICENSE.md file for details
Acknowledgments
None yet!
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.