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

Uploaded Source

Built Distribution

iambic-1.0.1-py3-none-any.whl (2.3 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: iambic-1.0.1.tar.gz
  • Upload date:
  • Size: 2.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.2 CPython/3.8.1 Darwin/19.4.0

File hashes

Hashes for iambic-1.0.1.tar.gz
Algorithm Hash digest
SHA256 2db3cdd14149fb785d2b69ebfcb9769a5a822067f25c8986922521d024f1b714
MD5 e2065969dcb4cd65b636183c47d8de5b
BLAKE2b-256 301b1d1326db67d0ac8d916edff184015a6047f44d650ad97c991831fb899b9b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: iambic-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 2.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.2 CPython/3.8.1 Darwin/19.4.0

File hashes

Hashes for iambic-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 08e784b208ea0d98c0cb3003e5ca91eceb2c0170cee1c3727f84be7adbb41531
MD5 8505177cedcbd92251254ef56525e563
BLAKE2b-256 61c4bce1754d91b619677366f57a64a250cd43794cb7fa1b8b31726b919abb46

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