Metadata-Version: 2.4
Name: cereja
Version: 2.1.5
Summary: Cereja is a bundle of useful functions that I don't want to rewrite.
Author-email: Joab Leite <leitejoab@gmail.com>
License: Copyright (c) 2019 The Cereja Project
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/cereja-project/cereja
Project-URL: Bug Tracker, https://github.com/cereja-project/cereja/issues/new/choose
Keywords: progress bar,utils,array,pln,file utils
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# Cereja

[![Python package](https://github.com/cereja-project/cereja/actions/workflows/pythonpackage.yml/badge.svg)](https://github.com/cereja-project/cereja/actions/workflows/pythonpackage.yml)
[![PyPI version](https://badge.fury.io/py/cereja.svg)](https://badge.fury.io/py/cereja)
[![Downloads](https://pepy.tech/badge/cereja)](https://pepy.tech/project/cereja)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)

Cereja is a Python utility package for developers who want reusable helpers for files, paths, progress display,
compression, hashing, text processing, data preparation, arrays, dates, and small system tasks.

The package is published on PyPI and supports Python 3.11 and newer.

## Design principles

- Zero runtime dependencies
- Standard-library-first implementations
- Small, reusable and composable APIs
- Backward compatibility where practical
- Educational implementations without hiding Python internals


## Installation

```bash
python -m pip install cereja
```

## Quick Start

```python
import cereja as cj

path = cj.Path(".")
print(path.list_files())
```

```python
from cereja.file import FileIO

file = FileIO.create("./example.txt", ["first line", "second line"])
file.add("third line")
file.save()
```

## CLI

```bash
cereja --help
cereja tree .
cereja compress path/to/input
cereja decompress archive.cjz
```

Progress is enabled by default for CLI compression and decompression. Use `--quiet` for script-friendly output.

## Development

```bash
git clone https://github.com/cereja-project/cereja.git
cd cereja
python -m pip install -e .
python -m unittest discover -s tests -v
```

Run the syntax/undefined-name lint used by CI:

```bash
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
```

## Documentation

- Documentation: <https://cereja.readthedocs.io/>
- Source code: <https://github.com/cereja-project/cereja>
- Issues: <https://github.com/cereja-project/cereja/issues/new/choose>
- PyPI: <https://pypi.org/project/cereja/>
- Examples notebook: [docs/cereja_example.ipynb](docs/cereja_example.ipynb)

## Citation

If you use Cereja in academic work, please cite it. GitHub uses `CITATION.cff` for the "Cite this repository" button,
and a BibTeX entry is available in `CITATION.bib`.

## License

Cereja is distributed under the MIT License. See [LICENSE](LICENSE) for details.
