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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: iambic-2.4.0.tar.gz
  • Upload date:
  • Size: 2.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.2 CPython/3.8.1 Darwin/19.6.0

File hashes

Hashes for iambic-2.4.0.tar.gz
Algorithm Hash digest
SHA256 de35f7d7025102c255496bac8a364f703866c9106c7fd4d9d1bfaa45d49a8a8e
MD5 71442ab4d36b1bc0ab26a8e2f08a6c3e
BLAKE2b-256 060a6cbce8736a9468d01d2e5350a94b850ef23cab785671e9cc92d7ef0fd676

See more details on using hashes here.

File details

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

File metadata

  • Download URL: iambic-2.4.0-py3-none-any.whl
  • Upload date:
  • Size: 2.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.2 CPython/3.8.1 Darwin/19.6.0

File hashes

Hashes for iambic-2.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8b7809c0649e98bba3cb77f57d8668533225f3cee58f016cdda3aac8dd1f5db2
MD5 4f215b35d0cd9f08c6d394646d7799b3
BLAKE2b-256 de7f1aee95b5d9b0c406b3eb252999557dbb783b00743fe05027e70ac8f8e79a

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