iambic: Data extraction and rendering library for Shakespearean text. :scroll:
==============================================================================
[![image](https://img.shields.io/pypi/v/iambic.svg)](https://pypi.org/project/iambic/)
[![image](https://img.shields.io/pypi/l/iambic.svg)](https://pypi.org/project/iambic/)
[![image](https://img.shields.io/pypi/pyversions/iambic.svg)](https://pypi.org/project/iambic/)
[![image](https://img.shields.io/github/languages/code-size/seandstewart/iambic.svg?style=flat)](https://github.com/seandstewart/iambic)
[![image](https://img.shields.io/travis/seandstewart/iambic.svg)](https://travis-ci.org/seandstewart/iambic)
[![codecov](https://codecov.io/gh/seandstewart/iambic/branch/master/graph/badge.svg)](https://codecov.io/gh/seandstewart/iambic)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
[![Netlify Status](https://api.netlify.com/api/v1/badges/91ace14b-e26e-4026-ac5c-3e5640f2910f/deploy-status)](https://app.netlify.com/sites/iambic/deploys)
Let computers do the hard work for you! `iambic` provides:
1. The most accurate method for counting lines automatically.
2. Automatically track which characters are speaking in any scene.
3. Deterministic, repeatable results, with the ability to store your
data as JSON with strictly defined schema for passing over the wire
or storing locally or in a NoSQL database between runtimes.
## Installation
In order to install the latest version, simply `pip3 install
-U iambic`.
This library requires Python 3.7 or greater.
## What is it?
`iambic` was originally envisioned as a tool for translating
Shakespearean text into actionable information, i.e.:
1. How many lines are in this particular play?
2. How many lines does a given character speak in this play?
3. Which characters speak, in which scenes and acts?
As a result of the implementation, this tool can be applied
to any body of text which adhere's to its parsing syntax.
## The Schema
The full schema specification has been written in JSON
Schema 7.0 and can be found
[here](schema.json)
## Documentation
The full documentation is available at
[iambic.seandstewart.io](https://iambic.seandstewart.io)
## How to Contribute
1. Check for open issues or open a fresh issue to start a
discussion around a feature idea or a bug.
2. Create a branch on Github for your issue or fork
[the repository](https://github.com/seandstewart/iambic)
on GitHub to start making your changes to the **master**
branch.
3. Write a test which shows that the bug was fixed or that
the feature works as expected.
4. Send a pull request and bug the maintainer until it gets
merged and published. :)
Raw data
{
"_id": null,
"home_page": "https://github.com/seandstewart/iambic",
"name": "iambic",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11,<4.0",
"maintainer_email": "",
"keywords": "text,render,shakespeare,text-processing",
"author": "Sean Stewart",
"author_email": "sean_stewart@me.com",
"download_url": "https://files.pythonhosted.org/packages/f6/23/cd45ea49c45eaac25beeeebbb4e86fdc04676722454a28b0f2079126d150/iambic-3.0.0.tar.gz",
"platform": null,
"description": "iambic: Data extraction and rendering library for Shakespearean text. :scroll: \n==============================================================================\n[![image](https://img.shields.io/pypi/v/iambic.svg)](https://pypi.org/project/iambic/)\n[![image](https://img.shields.io/pypi/l/iambic.svg)](https://pypi.org/project/iambic/)\n[![image](https://img.shields.io/pypi/pyversions/iambic.svg)](https://pypi.org/project/iambic/)\n[![image](https://img.shields.io/github/languages/code-size/seandstewart/iambic.svg?style=flat)](https://github.com/seandstewart/iambic)\n[![image](https://img.shields.io/travis/seandstewart/iambic.svg)](https://travis-ci.org/seandstewart/iambic)\n[![codecov](https://codecov.io/gh/seandstewart/iambic/branch/master/graph/badge.svg)](https://codecov.io/gh/seandstewart/iambic)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)\n[![Netlify Status](https://api.netlify.com/api/v1/badges/91ace14b-e26e-4026-ac5c-3e5640f2910f/deploy-status)](https://app.netlify.com/sites/iambic/deploys)\n\nLet computers do the hard work for you! `iambic` provides:\n1. The most accurate method for counting lines automatically.\n2. Automatically track which characters are speaking in any scene.\n3. Deterministic, repeatable results, with the ability to store your\n data as JSON with strictly defined schema for passing over the wire\n or storing locally or in a NoSQL database between runtimes.\n\n\n## Installation\n\nIn order to install the latest version, simply `pip3 install\n-U iambic`.\n\nThis library requires Python 3.7 or greater.\n\n\n## What is it?\n`iambic` was originally envisioned as a tool for translating\nShakespearean text into actionable information, i.e.:\n1. How many lines are in this particular play?\n2. How many lines does a given character speak in this play?\n3. Which characters speak, in which scenes and acts?\n\nAs a result of the implementation, this tool can be applied \nto any body of text which adhere's to its parsing syntax.\n\n\n## The Schema\nThe full schema specification has been written in JSON\nSchema 7.0 and can be found\n[here](schema.json)\n\n## Documentation\n\nThe full documentation is available at\n[iambic.seandstewart.io](https://iambic.seandstewart.io)\n\n\n## How to Contribute\n1. Check for open issues or open a fresh issue to start a \n discussion around a feature idea or a bug.\n2. Create a branch on Github for your issue or fork\n [the repository](https://github.com/seandstewart/iambic)\n on GitHub to start making your changes to the **master**\n branch.\n3. Write a test which shows that the bug was fixed or that \n the feature works as expected.\n4. Send a pull request and bug the maintainer until it gets\n merged and published. :)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Data extraction and rendering library for Shakespearean text.",
"version": "3.0.0",
"project_urls": {
"Homepage": "https://github.com/seandstewart/iambic",
"Repository": "https://github.com/seandstewart/iambic"
},
"split_keywords": [
"text",
"render",
"shakespeare",
"text-processing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8cf06026d5a81de908e161d7afb758eb505befa40787d9b3d19c5671c963aac8",
"md5": "7356cf089aaf149ea0900487dc5f7b94",
"sha256": "856c99ddf50c497d00679784440f78eda726d154a1f15a7ec1184cd0864721ee"
},
"downloads": -1,
"filename": "iambic-3.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7356cf089aaf149ea0900487dc5f7b94",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11,<4.0",
"size": 2061715,
"upload_time": "2023-06-25T23:05:35",
"upload_time_iso_8601": "2023-06-25T23:05:35.526971Z",
"url": "https://files.pythonhosted.org/packages/8c/f0/6026d5a81de908e161d7afb758eb505befa40787d9b3d19c5671c963aac8/iambic-3.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f623cd45ea49c45eaac25beeeebbb4e86fdc04676722454a28b0f2079126d150",
"md5": "93d47276fbc7d20617d10735892af7fb",
"sha256": "b4193073e3820123ccb630caf577944d5dfeb79677c6f389853ec9e8a9a7afeb"
},
"downloads": -1,
"filename": "iambic-3.0.0.tar.gz",
"has_sig": false,
"md5_digest": "93d47276fbc7d20617d10735892af7fb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11,<4.0",
"size": 2012747,
"upload_time": "2023-06-25T23:05:37",
"upload_time_iso_8601": "2023-06-25T23:05:37.054937Z",
"url": "https://files.pythonhosted.org/packages/f6/23/cd45ea49c45eaac25beeeebbb4e86fdc04676722454a28b0f2079126d150/iambic-3.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-25 23:05:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "seandstewart",
"github_project": "iambic",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "iambic"
}