Metadata-Version: 2.4
Name: cistercian
Version: 1.0.1
Summary: A library for generating Cistercian Numeral images.
Home-page: https://github.com/teeale/Cistercian
Author: tealee
Author-email: tealej7@gmail.com
Keywords: numerals,cistercian,images
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Text Processing :: Linguistic
Classifier: Topic :: Utilities
Classifier: Development Status :: 4 - Beta
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: Pillow>=8.0.0
Dynamic: license-file

[![Cistercian](https://i.imgur.com/KCge7Lv.png)](https://github.com/teeale/Cistercian)
<h1 align="center">
  <b>Cistercian</b> - Image Generator for Cistercian Numerals
  <br>
</h1>

The medieval Cistercian numerals were developed by the Cistercian monastic order in the early thirteenth century. These numeral representations are compounded on a single stave to indicate more complex numbers. The Cistercians eventually abandoned the system in favor of the Arabic numerals, but marginal use outside the order continued until the early twentieth century.

This Python library will create an image of the relevant numeral based on the integer provided.

## Installation

Install from PyPi.

```
pip install cistercian
```

## Usage

The `create` function takes 4 arguments:
- The integer to convert.
- `background_colour`: Background colour of the image
- `line_colour`: Colour of the lines used to compose the numeral
- `height`: Image height. This uses a scale factor to ensure an appropriate image width

```py
import cistercian

>>> cistercian.create(3875, background_colour="teal", line_colour="black", height=350)
```
