Metadata-Version: 2.1
Name: sungai
Version: 0.1.0
Summary: Sungai is a directory rating tool
Home-page: https://github.com/hugocartwright/sungai
Download-URL: https://pypi.org/project/sungai/
Author: Hugo Cartwright
Author-email: hugo.cartw@gmail.com
License: MIT License
Project-URL: Source, https://github.com/hugocartwright/sungai
Keywords: Python
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Software Development
Classifier: Topic :: Utilities
Requires-Python: >3.6.0
Description-Content-Type: text/markdown
License-File: LICENSE

# Sungai

![GitHub](https://img.shields.io/github/license/hugocartwright/sungai)![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/hugocartwright/sungai/tests.yaml)![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/hugocartwright/sungai)![GitHub all releases](https://img.shields.io/github/downloads/hugocartwright/sungai/total)![GitHub last commit](https://img.shields.io/github/last-commit/hugocartwright/sungai)
![PyPI](https://img.shields.io/pypi/v/sungai)![PyPI - Implementation](https://img.shields.io/pypi/implementation/sungai)![PyPI - Python Version](https://img.shields.io/pypi/pyversions/sungai)![PyPI - Wheel](https://img.shields.io/pypi/wheel/sungai)![PyPI - Downloads](https://img.shields.io/pypi/dm/sungai)

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.
Examples include:
- moving them up to their parent directory
- rearranging their files
- grouping their directories into new ones
- ignoring sungai
- altogether deleting the given directories

Sungai can not yet be configured to ignore given files or directories as is customary with .gitignore or .dockerignore files.


## Contributing
Feel free to drop an issue on the project's github page.
