Skip to main content

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.

Metadata

Release files for sungai 0.1.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sungai 0.1.8
File Size Uploaded
sungai-0.1.8.tar.gz 10.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for sungai 0.1.8
File Interpreter ABI Platform
sungai-0.1.8-py3-none-any.whl Python 3 none any Details

Total release size: 17.8 kB

Release files / sungai-0.1.8.tar.gz

Download URL sungai-0.1.8.tar.gz
Size 10.0 kB
Tags Source
SHA-256 checksum
How to use checksums
59914a063ba7a7b8bd9e9c3cfd4c9b17b6ec8fb1bfaa17f3c445f523207b66bf
BLAKE2b-256 checksum
How to use checksums
ebcb242480a0f5b22cdb25b4aa3791af99c6c56e4efafbc28537c7d5f37b3bcb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.9

Release files / sungai-0.1.8-py3-none-any.whl

Download URL sungai-0.1.8-py3-none-any.whl
Size 7.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
51e781b05161caa0a6acf4e53b344ec68791a549e7992056272410ed8331ce6f
BLAKE2b-256 checksum
How to use checksums
3b26908166e43c726b69bf7a7eceb0f34c83793aa733225e3ebd6e4b7105ad3d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.9

Release history Release notifications | RSS feed

This release

0.1.8 This release

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

1 release file

0.1.0

1 release file

0.0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page