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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: iambic-1.0.0.tar.gz
  • Upload date:
  • Size: 2.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.0 CPython/3.7.3 Darwin/18.7.0

File hashes

Hashes for iambic-1.0.0.tar.gz
Algorithm Hash digest
SHA256 e81222c17bc70bdc0385395071b19af77c86d2e2e60d5706c7d29cab56d1898e
MD5 82658640d78b61357081f3ace3cc776d
BLAKE2b-256 2e1c4565d2982f1c90b8865c37d1487f3864fd3faf65ad1110574eeb10f4bc7e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: iambic-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 2.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.0 CPython/3.7.3 Darwin/18.7.0

File hashes

Hashes for iambic-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f6990eb784da6b7fc30acd6ac6370bfbf2d12bb1ac0fbb41da7990bee270970d
MD5 dc4bea10b6745260f19f0cc999c57ada
BLAKE2b-256 550c07f0056992d4f3ecc52f414d8c23c1311f3d4d915eb0f865c307d4aa9e0f

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