Metadata-Version: 2.1
Name: stirling
Version: 0.9.0
Summary: Set partitioning
Home-page: https://github.com/rob-smallshire/stirling
Author: Robert Smallshire
Author-email: robert+stirling@smallshire.org.uk
License: MIT License
Keywords: sets partitioning
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: doc
Provides-Extra: test
License-File: LICENSE.txt

# Stirling

[![Documentation Status](https://readthedocs.org/projects/stirling/badge/?version=latest)](https://stirling.readthedocs.io/en/latest/?badge=latest)

![CI](https://github.com/rob-smallshire/stirling/actions/workflows/actions.yml/badge.svg)


[![codecov](https://codecov.io/gh/rob-smallshire/stirling/branch/master/graph/badge.svg?token=66QU3UW6N3)](https://codecov.io/gh/rob-smallshire/stirling)

## Installation

    $ pip install stirling


## Examples

A collection of utility functions for processing iterable series which
aren't in [itertools](https://docs.python.org/3/library/itertools.html) or [more-itertools](https://more-itertools.readthedocs.io). Some are little more than simple aliases with less confusing names.

    >>> from stirling import k_subsets
    >>> for arrangement in k_subsets([1, 2, 3, 4], 3):
    ...    print(arrangement)
    ...
    [[1, 2], [3], [4]]
    [[1, 3], [2], [4]]
    [[1], [2, 3], [4]]
    [[1, 4], [2], [3]]
    [[1], [2, 4], [3]]
    [[1], [2], [3, 4]]

## CI/CD

    $ bumpversion patch
    $ git push --follow-tags
MIT License

Copyright (c) Robert Smallshire

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.
