# dir-audit
| | |
|---|---|
|Project|[](https://www.python.org/) [](LICENSE) |
|Quality| [](https://github.com/deltodon/dir-audit/issues) |
| Tools | [](https://pre-commit.com/) [](https://python-poetry.org/) |
|Community|[](https://github.com/deltodon/dir-audit/graphs/commit-activity) [](https://github.com/deltodon/dir-audit) [](https://github.com/deltodon/dir-audit/network/members) [](https://github.com/deltodon/dir-audit/graphs/contributors) [](https://github.com/deltodon/dir-audit/commits/main)|
Directory tree audit tool
### Setup
install with pip
```bash
pip install dir-audit
```
or with [Poetry](https://python-poetry.org/)
```bash
poetry add dir-audit
```
### Usage
get help
```bash
poetry run python dir_audit --help
usage: dir-audit [-h] [-v] {make,check} ...
Audit directory tree structure
positional arguments:
{make,check} Audit command
make Make directory tree
check Check directory tree
options:
-h, --help show this help message and exit
-v, --version Get dir-audit version
```
> NOTE: `make` command is still work in progress.
check for empty directories
```bash
poetry run python dir_audit check --empty /path/to/your/directory
```
check for files and directories that contain substring (i.e.: `admin`)
```bash
poetry run python dir_audit check --contains admin /path/to/your/directory
```
print full directory tree
```bash
poetry run python dir_audit check --full /path/to/your/directory
```
Raw data
{
"_id": null,
"home_page": "https://github.com/deltodon/dir-audit",
"name": "dir-audit",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "Directory, Tree, Search",
"author": "Jiri Klic",
"author_email": "web@jiriklic.com",
"download_url": "https://files.pythonhosted.org/packages/b7/a3/fee303022e1ea4417fc788a3fbef861e4dc38bee24e70526125c5180d829/dir_audit-0.3.2.tar.gz",
"platform": null,
"description": "# dir-audit\n\n| | |\n|---|---|\n|Project|[](https://www.python.org/) [](LICENSE) |\n|Quality| [](https://github.com/deltodon/dir-audit/issues) |\n| Tools | [](https://pre-commit.com/) [](https://python-poetry.org/) |\n|Community|[](https://github.com/deltodon/dir-audit/graphs/commit-activity) [](https://github.com/deltodon/dir-audit) [](https://github.com/deltodon/dir-audit/network/members) [](https://github.com/deltodon/dir-audit/graphs/contributors) [](https://github.com/deltodon/dir-audit/commits/main)|\n\nDirectory tree audit tool\n\n### Setup\n\ninstall with pip\n\n```bash\npip install dir-audit\n```\n\nor with [Poetry](https://python-poetry.org/)\n\n```bash\npoetry add dir-audit\n```\n\n### Usage\n\nget help\n\n```bash\npoetry run python dir_audit --help\nusage: dir-audit [-h] [-v] {make,check} ...\n\nAudit directory tree structure\n\npositional arguments:\n {make,check} Audit command\n make Make directory tree\n check Check directory tree\n\noptions:\n -h, --help show this help message and exit\n -v, --version Get dir-audit version\n```\n\n> NOTE: `make` command is still work in progress.\n\ncheck for empty directories\n\n```bash\npoetry run python dir_audit check --empty /path/to/your/directory\n```\n\ncheck for files and directories that contain substring (i.e.: `admin`)\n\n```bash\npoetry run python dir_audit check --contains admin /path/to/your/directory\n```\n\nprint full directory tree\n\n```bash\npoetry run python dir_audit check --full /path/to/your/directory\n```\n\n",
"bugtrack_url": null,
"license": "GPL-3.0",
"summary": "Directory tree audit tool",
"version": "0.3.2",
"project_urls": {
"Homepage": "https://github.com/deltodon/dir-audit",
"Repository": "https://github.com/deltodon/dir-audit"
},
"split_keywords": [
"directory",
" tree",
" search"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5eb24d61bd6cd51a1580fc7596b8eb8341cfd2533872ddf9e639e1699b284ff4",
"md5": "005cb0f196a3285103fc70c930ed5ae3",
"sha256": "d4a5e381daddd983b0bd9d528b208e19b8b2ba5bfafeccd32c4129d4d32b4e0d"
},
"downloads": -1,
"filename": "dir_audit-0.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "005cb0f196a3285103fc70c930ed5ae3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 16138,
"upload_time": "2024-10-20T16:43:10",
"upload_time_iso_8601": "2024-10-20T16:43:10.437618Z",
"url": "https://files.pythonhosted.org/packages/5e/b2/4d61bd6cd51a1580fc7596b8eb8341cfd2533872ddf9e639e1699b284ff4/dir_audit-0.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b7a3fee303022e1ea4417fc788a3fbef861e4dc38bee24e70526125c5180d829",
"md5": "afa3902857282008d201f8acc85e5471",
"sha256": "87579aeb56d78b897843a8ae56c95505fd153f775fc069b19c3b04480303e41a"
},
"downloads": -1,
"filename": "dir_audit-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "afa3902857282008d201f8acc85e5471",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 15025,
"upload_time": "2024-10-20T16:43:11",
"upload_time_iso_8601": "2024-10-20T16:43:11.378281Z",
"url": "https://files.pythonhosted.org/packages/b7/a3/fee303022e1ea4417fc788a3fbef861e4dc38bee24e70526125c5180d829/dir_audit-0.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-20 16:43:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "deltodon",
"github_project": "dir-audit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "dir-audit"
}
JSON
