# Charnetto
This module is designed to create an automated character network based on a book or a movie script.
## Getting started
Charnetto is implemented both with spaCy and Flair for the named entity recognition step. Please install the desired library using
```
pip install spacy
```
or
```
pip install flair
```
For more information, see the [online documentation](https://charnetto.readthedocs.io/en/latest/).
## How to use charnetto
You can use the Jupyter Notebook `charnetto_example.ipynb` to see a full example of how to generate a character network based on a book (with Flair as a NER tool or with manual annotations) or on a movie script.
## Supported data
* The books must be in `.txt`, ideally with one paragraph per line. For english books, replacing `,'` by `',` at the end of dialogues tends to give better results with the NER part.
* The movie scripts need to resemble those available on [IMSDB](https://imsdb.com/): the regex for character names looks for capital letters preceded by at least two line breaks.
* If you want to annotate some books manually, you can follow the URL notation in Markdown to identify characters. Online editors like [StackEdit](https://stackedit.io/) allow you to double-click on a name and add an URL (with `CTRL+L`). By writing `PER` in the URL part (for the tag "PERSON"), you will then be able to use charnetto to extract the annotated entities and generate a character network.
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/maned_wolf/charnetto",
"name": "charnetto",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "character networks, networks, books, movies, network extraction",
"author": "Coline M\u00e9trailler",
"author_email": "Coline M\u00e9trailler <coline.metrailler@unil.ch>",
"download_url": "https://files.pythonhosted.org/packages/73/43/13f9f9cf3aa571cca86c130d84eb38d860cdf9b4ef6bdd40b1fd51fc0abb/charnetto-0.1.5.tar.gz",
"platform": null,
"description": "# Charnetto\r\n\r\nThis module is designed to create an automated character network based on a book or a movie script.\r\n\r\n## Getting started\r\n\r\nCharnetto is implemented both with spaCy and Flair for the named entity recognition step. Please install the desired library using\r\n\r\n```\r\npip install spacy\r\n```\r\n\r\nor \r\n\r\n```\r\npip install flair\r\n```\r\n\r\nFor more information, see the [online documentation](https://charnetto.readthedocs.io/en/latest/).\r\n\r\n## How to use charnetto\r\n\r\nYou can use the Jupyter Notebook `charnetto_example.ipynb` to see a full example of how to generate a character network based on a book (with Flair as a NER tool or with manual annotations) or on a movie script.\r\n\r\n## Supported data\r\n* The books must be in `.txt`, ideally with one paragraph per line. For english books, replacing `,'` by `',` at the end of dialogues tends to give better results with the NER part.\r\n\r\n* The movie scripts need to resemble those available on [IMSDB](https://imsdb.com/): the regex for character names looks for capital letters preceded by at least two line breaks.\r\n\r\n* If you want to annotate some books manually, you can follow the URL notation in Markdown to identify characters. Online editors like [StackEdit](https://stackedit.io/) allow you to double-click on a name and add an URL (with `CTRL+L`). By writing `PER` in the URL part (for the tag \"PERSON\"), you will then be able to use charnetto to extract the annotated entities and generate a character network.\r\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "automated character networks for books and movie scripts",
"version": "0.1.5",
"project_urls": {
"Documentation": "https://charnetto.readthedocs.io/en/latest/",
"Homepage": "https://gitlab.com/maned_wolf/charnetto",
"Issues": "https://gitlab.com/maned_wolf/charnetto/-/issues",
"Repository": "https://gitlab.com/maned_wolf/charnetto"
},
"split_keywords": [
"character networks",
" networks",
" books",
" movies",
" network extraction"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f5b0a7783562cd0b30f70685694025738a0ef15a490ab7a5d2cbab38b6ff65fe",
"md5": "0e3b2c0448d4addfc56ef82577cbfb1f",
"sha256": "a74843b04b4c7ca46ac3e70f0c643fe14213a2243a5eb4c552e7c4356eca61e0"
},
"downloads": -1,
"filename": "charnetto-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0e3b2c0448d4addfc56ef82577cbfb1f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 14518,
"upload_time": "2024-03-22T13:22:56",
"upload_time_iso_8601": "2024-03-22T13:22:56.178122Z",
"url": "https://files.pythonhosted.org/packages/f5/b0/a7783562cd0b30f70685694025738a0ef15a490ab7a5d2cbab38b6ff65fe/charnetto-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "734313f9f9cf3aa571cca86c130d84eb38d860cdf9b4ef6bdd40b1fd51fc0abb",
"md5": "b5b7317ef7d5b81e5c2aea08f9a38c31",
"sha256": "96b34d4b3e6d523cea354fee40f225850f6684c0d1cd82ae995fb1aa263960c4"
},
"downloads": -1,
"filename": "charnetto-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "b5b7317ef7d5b81e5c2aea08f9a38c31",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 12179,
"upload_time": "2024-03-22T13:22:58",
"upload_time_iso_8601": "2024-03-22T13:22:58.120313Z",
"url": "https://files.pythonhosted.org/packages/73/43/13f9f9cf3aa571cca86c130d84eb38d860cdf9b4ef6bdd40b1fd51fc0abb/charnetto-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-22 13:22:58",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "maned_wolf",
"gitlab_project": "charnetto",
"lcname": "charnetto"
}
JSON