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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: iambic-2.0.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-1032-azure

File hashes

Hashes for iambic-2.0.0.tar.gz
Algorithm Hash digest
SHA256 fc582ce27689a9a2c6dedd31bc35ec02235923523d293f097a402d14d3920f90
MD5 bca192c93998ed7852a37b09e60dc4c0
BLAKE2b-256 e93e6ad168e04be2fb6342ccff178b6b92063d4a05083efc7ea3779308541487

See more details on using hashes here.

File details

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

File metadata

  • Download URL: iambic-2.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.10 CPython/3.7.8 Linux/5.3.0-1032-azure

File hashes

Hashes for iambic-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d6097e88a73d835d176d44c5a2cf37c50754abf6a2cf6a0e3c1af39cfe6f05bf
MD5 72c2401c378bded0d1bd70430cf3ec81
BLAKE2b-256 a44e5bb8f720f0aa896a278e2143986ca64c19c9628a78e0bb184db337e013d7

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