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.6.tar.gz (9.9 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.6-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sungai-0.1.6.tar.gz
  • Upload date:
  • Size: 9.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for sungai-0.1.6.tar.gz
Algorithm Hash digest
SHA256 cff3afba0a9337ac0630f3514b5c5047653e5db4d6544bb2921ca9fbfe2ed82d
MD5 db1b763f5c9ff7eeaa3fcaa23eaed2ad
BLAKE2b-256 3048ba74c8bc053dc851672919067fb23b2e421c5991d723f9e2fd854606fb93

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sungai-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 9.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for sungai-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 d99a66f3bdd4f9da0f38376665d9cdddd619e0b9034eb8a39bc5d4fba50abc40
MD5 f7307ee6a460037f2b8fb3e43ab7ec7a
BLAKE2b-256 6ffe2f6d0a33d9690e45abda29e270abdd6e2185b8f1fd510a1f2bea23880efb

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