Sungai is a directory structure rating tool
Project description
Sungai
Sungai is a tool for rating directory structure. In other words, it's great at giving pointers when cleaning up very messy directories.
Installation
Install with pip install sungai
Usage
To run sungai on current directory (".")
sungai .
The target directory will get a rating between 0.0 and 1.0. The minimum score required for the target directory can also be set with the --min_score flag. The error count should be 0 for a pass.
sungai <your_path_string_here> --min_score 1.0 --verbose
Sungai lists directory paths in descending order of priority.
CAUTION: It is entirely up to the user to rearrange the contents of those directories. Or not. Example actions include:
- moving them up to their parent directory
- rearranging their files
- grouping their directories into new ones
- ignoring sungai
- altogether deleting the given directories
Ignore files or directories
An ignore file path can be specified to sungai. The given file should follow the .gitignore syntax.
sungai <your_path_string_here> --ignore_config .sungai_ignore
Contributing
Feel free to drop an issue on the project's GitLab page.
Release history Release notifications | RSS feed
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sungai-0.1.8.tar.gz.
File metadata
- Download URL: sungai-0.1.8.tar.gz
- Upload date:
- Size: 10.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
59914a063ba7a7b8bd9e9c3cfd4c9b17b6ec8fb1bfaa17f3c445f523207b66bf
|
|
| MD5 |
e3e5256d96642b668bb6a4f4abffe493
|
|
| BLAKE2b-256 |
ebcb242480a0f5b22cdb25b4aa3791af99c6c56e4efafbc28537c7d5f37b3bcb
|
File details
Details for the file sungai-0.1.8-py3-none-any.whl.
File metadata
- Download URL: sungai-0.1.8-py3-none-any.whl
- Upload date:
- Size: 7.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
51e781b05161caa0a6acf4e53b344ec68791a549e7992056272410ed8331ce6f
|
|
| MD5 |
6b67783b41bfce0ca69f0e1e914ede1f
|
|
| BLAKE2b-256 |
3b26908166e43c726b69bf7a7eceb0f34c83793aa733225e3ebd6e4b7105ad3d
|
