Metadata-Version: 2.1
Name: eule
Version: 0.2.5
Summary: Euler diagrams in python
Home-page: https://pypi.org/project/eule/
License: MIT
Keywords: euler-diagram,sets
Author: Bruno Peixoto
Author-email: brunolnetto@gmail.com
Requires-Python: >=3.8.1,<4.0
Classifier: Development Status :: 6 - Mature
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Requires-Dist: black (>=22.12.0,<23.0.0)
Requires-Dist: coverage (>=7.0,<8.0)
Requires-Dist: docutils (>=0.19,<0.20)
Requires-Dist: isort (>=5.11.4,<6.0.0)
Requires-Dist: mypy (>=0.991,<0.992)
Requires-Dist: numpy (>=1.24.1,<2.0.0)
Requires-Dist: pygments (>=2.14.0,<3.0.0)
Requires-Dist: pytest-watch (>=4.2.0,<5.0.0)
Requires-Dist: ruff (>=0.0.209,<0.0.210)
Requires-Dist: sphinx (>=6.0.0,<7.0.0)
Requires-Dist: sphinxcontrib-serializinghtml (>=1.1.5,<2.0.0)
Requires-Dist: sphinxcontrib-websupport (>=1.2.4,<2.0.0)
Requires-Dist: tox (>=4.0.19,<5.0.0)
Requires-Dist: types-mock (>=4.0.15.2,<5.0.0.0)
Requires-Dist: watchdog (>=2.2.0,<3.0.0)
Requires-Dist: wheel (>=0.38.4,<0.39.0)
Project-URL: Repository, https://github.com/quivero/eule
Description-Content-Type: text/markdown

![a night owl](https://github.com/quivero/eule/blob/master/images/eule_small.png?raw=true)

[![Version](https://img.shields.io/pypi/v/eule.svg)](https://pypi.python.org/pypi/eule)
[![python](https://img.shields.io/pypi/pyversions/eule.svg)](https://pypi.org/project/eule/)
[![downloads](https://img.shields.io/pypi/dm/eule)](https://pypi.org/project/eule/)

[![codecov](https://codecov.io/gh/quivero/eule/branch/main/graph/badge.svg?token=PJMBaLIqar)](https://codecov.io/gh/quivero/eule)
[![Documentation Status](https://readthedocs.org/projects/eule/badge/?version=latest)](https://eule.readthedocs.io/en/latest/?version=latest)
[![Codecov workflow](https://github.com/quivero/eule/actions/workflows/test-coverage.yaml/badge.svg)](https://github.com/quivero/eule/actions/workflows/test-coverage.yaml)
[![Lint workflow](https://github.com/quivero/eule/actions/workflows/check-lint.yaml/badge.svg)](https://github.com/quivero/eule/actions/workflows/check-lint.yaml)

Euler\'s diagrams are non-empty Venn\'s diagrams. For further information about:

1. the library: read the documentation on URL <https://eule.readthedocs.io>;
2. Euler diagrams: read the wikipedia article <https://en.wikipedia.org/wiki/Euler_diagram>

Motivation
================

<img src="https://github.com/quivero/eule/blob/master/images/euler_venn.png?raw=true" width="400" height="364"/>

How to install
================

We run the command on desired installation environment:

``` {.bash}
    pip install eule
```

Minimal example
================

We run command `python example.py` on the folder with file `example.py` and following content:

``` {.python}
#!/usr/bin/env python
import eule

set = {
    'a': [1, 2, 3],
    'b': [2, 3, 4],
    'c': [3, 4, 5],
    'd': [3, 5, 6]
}

diagram = eule.spread_euler(set)

# Euler dictionary: {'a,b': [2], 'b,c': [4], 'a,b,c,d': [3], 'c,d': [5], 'd': [6], 'a': [1]}
print(diagram)
```

