Skip to main content

Data extraction and rendering library for Shakespearean text.

Project description

iambic: Data extraction and rendering library for Shakespearean text. :scroll:

image image image image image codecov Code style: black Netlify Status

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

Documentation

The full documentation is available at 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 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. :)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

iambic-2.3.2.tar.gz (2.0 MB view details)

Uploaded Source

Built Distribution

iambic-2.3.2-py3-none-any.whl (2.1 MB view details)

Uploaded Python 3

File details

Details for the file iambic-2.3.2.tar.gz.

File metadata

  • Download URL: iambic-2.3.2.tar.gz
  • Upload date:
  • Size: 2.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.10 CPython/3.7.8 Linux/5.3.0-1034-azure

File hashes

Hashes for iambic-2.3.2.tar.gz
Algorithm Hash digest
SHA256 456dedf9f8dd886559591dc425766812e1991a71199dfcd1fb427c9684d63f60
MD5 22e1fcf642c7a642d7f2d45fdd36b6fa
BLAKE2b-256 9fce74dfc2077dd39ca2811b24b977043fde5d9d76c6dc2bdc5f2f115f9558d0

See more details on using hashes here.

File details

Details for the file iambic-2.3.2-py3-none-any.whl.

File metadata

  • Download URL: iambic-2.3.2-py3-none-any.whl
  • Upload date:
  • Size: 2.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.10 CPython/3.7.8 Linux/5.3.0-1034-azure

File hashes

Hashes for iambic-2.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9257d339b3238fd141a0c890b55d2e88ab02816479ede64baa321d8610e42c6f
MD5 a6400f3df8ab1d132a7dc35ac089e597
BLAKE2b-256 8c1c5cb98bb5d5495d7a09df5439df04f5b035bd1541bde943b6c1b4dfe3fa13

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page