Skip to main content

Sungai is a directory rating tool

Project description

Sungai

GitHubGitHub code size in bytesGitHub last commit PyPIPyPI - ImplementationPyPI - Python VersionPyPI - WheelPyPI - Downloads

Sungai is a tool for rating directories. 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 github page.

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

sungai-0.1.7.tar.gz (10.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sungai-0.1.7-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

Details for the file sungai-0.1.7.tar.gz.

File metadata

  • Download URL: sungai-0.1.7.tar.gz
  • Upload date:
  • Size: 10.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.9

File hashes

Hashes for sungai-0.1.7.tar.gz
Algorithm Hash digest
SHA256 7ea7399b3fa0f2483c31f12c03503ece9ef5f9c441fc58dd5849230457f10110
MD5 b872b32be8056292b64785ceb440e761
BLAKE2b-256 8ae177ee36286f39c919f7dc21e9022993b81163462cee45dd7f84d7684cb1a4

See more details on using hashes here.

File details

Details for the file sungai-0.1.7-py3-none-any.whl.

File metadata

  • Download URL: sungai-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 7.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.9

File hashes

Hashes for sungai-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 b64b6a01d457fa24f13d035037fd64b6966dd5b292e4fd650df789ef1cb7a70f
MD5 1c3c1d32909a0ca20b0835cd9a003d1a
BLAKE2b-256 848db9ba84d202bc0bab440b9bcb26517a4df845ef8557ed653b2a38e64cefdc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page