https://github.com/nekitdev/orderings
Ordering enumeration and protocols.
https://github.com/nekitdev/orderings
ordering python
Last synced: 12 days ago
JSON representation
Ordering enumeration and protocols.
- Host: GitHub
- URL: https://github.com/nekitdev/orderings
- Owner: nekitdev
- License: mit
- Created: 2022-11-28T14:00:14.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-05T12:17:41.000Z (over 1 year ago)
- Last Synced: 2024-08-08T21:12:52.581Z (over 1 year ago)
- Topics: ordering, python
- Language: Python
- Homepage: https://nekitdev.github.io/orderings
- Size: 444 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# `orderings`
[![License][License Badge]][License]
[![Version][Version Badge]][Package]
[![Downloads][Downloads Badge]][Package]
[![Discord][Discord Badge]][Discord]
[![Documentation][Documentation Badge]][Documentation]
[![Check][Check Badge]][Actions]
[![Test][Test Badge]][Actions]
[![Coverage][Coverage Badge]][Coverage]
> *Ordering enumeration and protocols.*
## Installation
**Python 3.8 or above is required.**
### `pip`
Installing the library with `pip` is quite simple:
```console
$ pip install orderings
```
Alternatively, the library can be installed from source:
```console
$ pip install git+https://github.com/nekitdev/orderings.git
```
Or via cloning the repository:
```console
$ git clone https://github.com/nekitdev/orderings.git
$ cd orderings
$ pip install .
```
### `poetry`
You can add `orderings` as a dependency with the following command:
```console
$ poetry add orderings
```
Or by directly specifying it in the configuration like so:
```toml
[tool.poetry.dependencies]
orderings = "^1.6.0"
```
Alternatively, you can add it directly from the source:
```toml
[tool.poetry.dependencies.orderings]
git = "https://github.com/nekitdev/orderings.git"
```
## Motivation
Sometimes it's simpler to handle ordering in one method, for example when comparing iterators;
then it's trivial to implement the regular ordering methods using the `compare` method.
## Examples
### Core
The core of `orderings` is the [`Ordering`][orderings.core.Ordering] enumeration
and the [`Compare`][orderings.core.Compare] protocol:
```python
from typing import Generic, TypeVar
from attrs import frozen
from orderings import Compare, Ordered, Ordering, compare
from typing_extensions import Self
T = TypeVar("T", bound=Ordered)
@frozen()
class Wrap(Compare, Generic[T]):
value: T
def compare(self, other: Self) -> Ordering:
return compare(self.value, other.value)
```
[`Compare`][orderings.core.Compare] implements all ordering operations
(`==`, `!=`, `<`, `>`, `<=`, `>=`) using the [`compare`][orderings.core.Compare.compare] method.
## Documentation
You can find the documentation [here][Documentation].
## Support
If you need support with the library, you can send an [email][Email]
or refer to the official [Discord server][Discord].
## Changelog
You can find the changelog [here][Changelog].
## Security Policy
You can find the Security Policy of `orderings` [here][Security].
## Contributing
If you are interested in contributing to `orderings`, make sure to take a look at the
[Contributing Guide][Contributing Guide], as well as the [Code of Conduct][Code of Conduct].
## License
`orderings` is licensed under the MIT License terms. See [License][License] for details.
[Email]: mailto:support@nekit.dev
[Discord]: https://nekit.dev/chat
[Actions]: https://github.com/nekitdev/orderings/actions
[Changelog]: https://github.com/nekitdev/orderings/blob/main/CHANGELOG.md
[Code of Conduct]: https://github.com/nekitdev/orderings/blob/main/CODE_OF_CONDUCT.md
[Contributing Guide]: https://github.com/nekitdev/orderings/blob/main/CONTRIBUTING.md
[Security]: https://github.com/nekitdev/orderings/blob/main/SECURITY.md
[License]: https://github.com/nekitdev/orderings/blob/main/LICENSE
[Package]: https://pypi.org/project/orderings
[Coverage]: https://codecov.io/gh/nekitdev/orderings
[Documentation]: https://nekitdev.github.io/orderings
[Discord Badge]: https://img.shields.io/discord/728012506899021874
[License Badge]: https://img.shields.io/pypi/l/orderings
[Version Badge]: https://img.shields.io/pypi/v/orderings
[Downloads Badge]: https://img.shields.io/pypi/dm/orderings
[Documentation Badge]: https://github.com/nekitdev/orderings/workflows/docs/badge.svg
[Check Badge]: https://github.com/nekitdev/orderings/workflows/check/badge.svg
[Test Badge]: https://github.com/nekitdev/orderings/workflows/test/badge.svg
[Coverage Badge]: https://codecov.io/gh/nekitdev/orderings/branch/main/graph/badge.svg
[orderings.core.Compare]: https://nekitdev.github.io/orderings/reference/core#orderings.core.Compare
[orderings.core.Compare.compare]: https://nekitdev.github.io/orderings/reference/core#orderings.core.Compare.compare
[orderings.core.Ordering]: https://nekitdev.github.io/orderings/reference/core#orderings.core.Ordering