Metadata-Version: 2.1
Name: PyBackport
Version: 0.2.0
Summary: Python package to backport classes from new python releases (for example,
Author-email: Jaime Gonzalez Gomez <jim.gomez.dnn@gmail.com>
License: MIT license
Project-URL: Source, https://github.com/Jtachan/PyBackport.git
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

![tests_badge](https://github.com/Jtachan/PyBackport/actions/workflows/unittests.yml/badge.svg)
[![PyPI Version](https://img.shields.io/pypi/v/PyBackport)](https://pypi.org/project/PyBackport/)
[![Python Version](https://img.shields.io/badge/python-3.8+-blue)](https://www.python.org/downloads/) 
[![PyPI Downloads](https://img.shields.io/pypi/dm/PyBackport)](https://pypi.org/project/PyBackport/) 
[![MIT License](https://img.shields.io/github/license/Jtachan/PyBackport)](https://github.com/Jtachan/PyBackport/blob/master/LICENSE)
[![Docs](https://img.shields.io/badge/Read_the_docs-blue)](https://Jtachan.github.io/PyBackport/)

# Python Backport

The `py_back` modules serve three purposes:

* Enable the use of new base classes in older Python versions. For example, `enum.StrEnum` is new in Python 3.11, but `py_back` allows users on previous versions to use it too.
* Enable experimental classes not implemented in other modules. For example, `enum.TupleEnum` is not implemented in `enum`, but `py_back` allows users to create enumerations where its members are tuples.
* Provide of new classes containing commonly used constant values. For example, `py_back.colors` provides a wrapper to commonly used BGR color codes, like `BGR.WHITE` to use the color code `(255, 255, 255)`


## Setup

Install the package via pip.

```shell
pip install PyBackport
```

The latest changes on develop can be installed via pip + git:
```shell
pip install git+https://github.com/Jtachan/PyBackport.git@develop
```

## 📖 Documentation

Documentation can be found:

- At the released [mkdocs page](jtachan.github.io/PyBackport).
- Within the [`docs`](https://github.com/Jtachan/PyBackport/blob/main/docs/index.md) folder.
