| Name | walkmate JSON |
| Version |
1.5.0
JSON |
| download |
| home_page | None |
| Summary | Traverse the file tree. |
| upload_time | 2024-04-12 17:18:59 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.6 |
| license | # MIT License Copyright (c) 2024 Joel Lefkowitz Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
filesystem
traverse
tree
walk
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Walkmate
Traverse the file tree.
## Installation
```bash
pip install walkmate
```
## Usage
Given a multi-level directory structure:
```ascii
.
├── one.py
├── two.py
└── child
└── three.py
```
We can list all the files tree:
```python
>>> tree("test/fixtures")
["one.py", "two.py", "child/three.py"]
```
Filter with a regex:
```python
>>> tree("test/fixtures", r"one\.py$")
["one.py"]
```
Add exlude patterns too:
```python
>>> tree("test/fixtures", r"\.py$", [r"one\.py$"])
["two.py", "child/three.py"]
```
Specify the maximum depth:
```python
>>> tree("test/fixtures", depth=1)
["one.py", "two.py"]
```
Raw data
{
"_id": null,
"home_page": null,
"name": "walkmate",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "filesystem, traverse, tree, walk",
"author": null,
"author_email": "Joel Lefkowitz <joellefkowitz@hotmail.com>",
"download_url": "https://files.pythonhosted.org/packages/52/69/c69095be5ccbf81603f3c45509facf37b16eb1dec4254d22e9fd8befba81/walkmate-1.5.0.tar.gz",
"platform": null,
"description": "# Walkmate\n\nTraverse the file tree.\n\n## Installation\n\n```bash\npip install walkmate\n```\n\n## Usage\n\nGiven a multi-level directory structure:\n\n```ascii\n.\n\u251c\u2500\u2500 one.py\n\u251c\u2500\u2500 two.py\n\u2514\u2500\u2500 child\n \u2514\u2500\u2500 three.py\n```\n\nWe can list all the files tree:\n\n```python\n>>> tree(\"test/fixtures\")\n[\"one.py\", \"two.py\", \"child/three.py\"]\n```\n\nFilter with a regex:\n\n```python\n>>> tree(\"test/fixtures\", r\"one\\.py$\")\n[\"one.py\"]\n```\n\nAdd exlude patterns too:\n\n```python\n>>> tree(\"test/fixtures\", r\"\\.py$\", [r\"one\\.py$\"])\n[\"two.py\", \"child/three.py\"]\n```\n\nSpecify the maximum depth:\n\n```python\n>>> tree(\"test/fixtures\", depth=1)\n[\"one.py\", \"two.py\"]\n```\n",
"bugtrack_url": null,
"license": "# MIT License Copyright (c) 2024 Joel Lefkowitz Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Traverse the file tree.",
"version": "1.5.0",
"project_urls": {
"Homepage": "https://github.com/JoelLefkowitz/walkmate"
},
"split_keywords": [
"filesystem",
" traverse",
" tree",
" walk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dc5b1cec5d86b4556deaa5be234fccba5d2bbec00bd6420b4ed4467ed4e10624",
"md5": "0f7471999f37ac389738e4a6a74e9a75",
"sha256": "5024879da3e9de4ab67271d99279ed849b94b3c2c709c48dc2b3fd81bb75e659"
},
"downloads": -1,
"filename": "walkmate-1.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0f7471999f37ac389738e4a6a74e9a75",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 3687,
"upload_time": "2024-04-12T17:18:57",
"upload_time_iso_8601": "2024-04-12T17:18:57.494218Z",
"url": "https://files.pythonhosted.org/packages/dc/5b/1cec5d86b4556deaa5be234fccba5d2bbec00bd6420b4ed4467ed4e10624/walkmate-1.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5269c69095be5ccbf81603f3c45509facf37b16eb1dec4254d22e9fd8befba81",
"md5": "b720c974d003c3cf9fd7741a43fad33b",
"sha256": "626c5e84d589fd1e107d2e0d8f5f3aa0e2b251f72bfe38c4d7694c3158f49117"
},
"downloads": -1,
"filename": "walkmate-1.5.0.tar.gz",
"has_sig": false,
"md5_digest": "b720c974d003c3cf9fd7741a43fad33b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 2522,
"upload_time": "2024-04-12T17:18:59",
"upload_time_iso_8601": "2024-04-12T17:18:59.071739Z",
"url": "https://files.pythonhosted.org/packages/52/69/c69095be5ccbf81603f3c45509facf37b16eb1dec4254d22e9fd8befba81/walkmate-1.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-12 17:18:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "JoelLefkowitz",
"github_project": "walkmate",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "walkmate"
}
