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.0.tar.gz (2.3 MB view details)

Uploaded Source

Built Distribution

iambic-2.3.0-py3-none-any.whl (2.4 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: iambic-2.3.0.tar.gz
  • Upload date:
  • Size: 2.3 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.0.tar.gz
Algorithm Hash digest
SHA256 2270692e26fe94d4aa1ca37418d78ebf4f9044e800ee72d919735212337417df
MD5 78e42ce555985dac79cdcfd65b9ff08e
BLAKE2b-256 98d0cb2a089eb3fe0b4f1c887b21090f9f2b5ab1c0a09ab1378a9a835ecb2cdb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: iambic-2.3.0-py3-none-any.whl
  • Upload date:
  • Size: 2.4 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 347d8461f8ae3eb5cea9948d84095342e48b0bee587452206b0f36af59f08ad5
MD5 40c7a2625106df2066cfa54c1ed7f647
BLAKE2b-256 d0dfedd162fb77668fc900f8b5ed69b8a0a255c18c11be7975836f94ffde2a8c

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