Metadata-Version: 2.1
Name: renard-pipeline
Version: 0.4.0
Summary: Relationships Extraction from NARrative Documents
License: GPL-3.0-only
Author: Arthur Amalvy
Author-email: arthur.amalvy@univ-avignon.fr
Requires-Python: >=3.8,<3.11
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Provides-Extra: spacy
Provides-Extra: stanza
Requires-Dist: coreferee (>=1.4.0,<2.0.0) ; extra == "spacy"
Requires-Dist: datasets (>=2.16.1,<3.0.0)
Requires-Dist: grimbert (>=0.1.0,<0.2.0)
Requires-Dist: matplotlib (>=3.5.3,<4.0.0)
Requires-Dist: more-itertools (>=10.1.0,<11.0.0)
Requires-Dist: nameparser (>=1.1.0,<2.0.0)
Requires-Dist: networkx (>=2.6.3,<3.0.0)
Requires-Dist: nltk (>=3.6.5,<4.0.0)
Requires-Dist: pandas (>=2.0.0,<3.0.0)
Requires-Dist: pytest (>=7.2.1,<8.0.0)
Requires-Dist: seqeval (==1.2.2)
Requires-Dist: spacy (>=3.5.0,<4.0.0) ; extra == "spacy"
Requires-Dist: spacy-transformers (>=1.2.1,<2.0.0) ; extra == "spacy"
Requires-Dist: stanza (>=1.3.0,<2.0.0) ; extra == "stanza"
Requires-Dist: tibert (>=0.3.0,<0.4.0)
Requires-Dist: torch (>=2.0.0,!=2.0.1)
Requires-Dist: tqdm (>=4.62.3,<5.0.0)
Requires-Dist: transformers (>=4.36.0,<5.0.0)
Description-Content-Type: text/markdown

# Renard

Renard (Relationships Extraction from NARrative Documents) is a library for creating and using custom character networks extraction pipelines. Renard can extract dynamic as well as static character networks.

![Character network extracted from "Pride and Prejudice"](./docs/pp_white_bg.svg)


# Installation

You can install the latest version using pip:

> pip install renard-pipeline


# Documentation

Documentation, including installation instructions, can be found at https://compnet.github.io/Renard/

If you need local documentation, it can be generated using `Sphinx`. From the `docs` directory, `make html` should create documentation under `docs/_build/html`. 


# Tutorial

`renard_tutorial.py` is a tutorial in the `jupytext` format. You can open it as a notebook in Jupyter Notebook (or export it as a notebook with `jupytext --to ipynb renard-tutorial.py`).


# Running tests 

`Renard` uses `pytest` for testing. To launch tests, use the following command : 

> poetry run python -m pytest tests

Expensive tests are disabled by default. These can be run by setting the environment variable `RENARD_TEST_ALL` to `1`.


# Contributing

see [the "Contributing" section of the documentation](https://compnet.github.io/Renard/contributing.html).

