chunkify

An implementation of the grouping function documented in the itertools Python module. The function is dubbed chunkify here.

Getting Started

The steps below will create an environment for building the project. These steps assume you are on Fedora and familiar with the Linux command-line and Git.

Clone the project’s repository from GitHub.

git clone https://codeberg.org/jwillikers/chunkify.git

Change into the project’s directory.
```
cd chunkify
```
Install Poetry.
```
sudo dnf -y install poetry
```
Install the dependencies with Poetry.
```
poetry install
```
Install the pre-commit hooks for the project.
```
poetry run pre-commit install
```

Format

Use Black to format the Python code.

poetry run black .

Lint

Check the project for common programming errors with Pylint.

poetry run pylint -j 0 *.py

Check Static Typing

Check static typing with mypy.

poetry run mypy *.py

Test

Test cases are available for chunkify. Execute them with pytest. From the root directory of the project, run pytest.

poetry run pytest

Package

Build with Poetry.

poetry build

Contributing

Contributions in the form of issues, feedback, and even pull requests are welcome. Make sure to adhere to the project’s Code of Conduct.

Open Source Software

This project is built on the hard work of countless open source contributors. Several of these projects are enumerated below.

Code of Conduct

Refer to the project’s Code of Conduct for details.

License

This repository is licensed under the GPLv3, a copy of which is available here.

Authors

Jordan Williams