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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: iambic-2.2.2.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.2.2.tar.gz
Algorithm Hash digest
SHA256 2e7ce0753b2287d4323324b34041261b9a055fbfacdff78f81bb049a95c75174
MD5 b481825b5b12bd355a8474e510dffbf5
BLAKE2b-256 efab727dc988c47f894978de653c185e7fd9159f4fafc97af1d650d3c5ee773c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: iambic-2.2.2-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.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 dbd5f54f3905c9e8f44a80906578f1c68631c354432cc7fe70ede68af6e96481
MD5 b45d7195bff7b6fe1e5f0851b2f18c01
BLAKE2b-256 a35d9dd789f5869de9c00383cdd0cf21bc6e430a0777da08b3e6ed4f022ac410

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