Skip to main content

A library for parsing and rendering Fountain screenplays.

Project description

Fountain is a plain text markup language for screenwriting. Jouvence is a Python package for parsing and rendering Fountain documents.

Jouvence supports:

  • Most of the Fountain specification (see limitations below).

  • Rendering to HTML and terminals.

Installation

As with many Python packages, it’s recommended that you use virtualenv, but since Jouvence doesn’t have many dependencies, you should be fine.

You can install Jouvence the usual way:

pip install jouvence

If you want to test that it works, you can feed it a Fountain screenplay and see if it prints it nicely in your terminal:

jouvence <path-to-fountain-file>

You should then see the Fountain file rendered with colored and indented styles.

Usage

The Jouvence API goes pretty much like this:

from jouvence.parser import JouvenceParser
from jouvence.html import HtmlDocumentRenderer

parser = JouvenceParser()
document = parser.parse(path_to_file)
renderer = HtmlDocumentRenderer()
markup = renderer.render_doc(document)
return markup

Limitations

Jouvence doesn’t support the complete Fountain syntax yet. The following things are not implemented yet:

  • Dual dialogue

  • Notes

  • Boneyards

  • Sections and synopses

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

Jouvence-0.2.1.tar.gz (15.3 kB view details)

Uploaded Source

File details

Details for the file Jouvence-0.2.1.tar.gz.

File metadata

  • Download URL: Jouvence-0.2.1.tar.gz
  • Upload date:
  • Size: 15.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Jouvence-0.2.1.tar.gz
Algorithm Hash digest
SHA256 55c444e4be9fb4e527046be360116644b60478e814264b9ca6347e031fbac114
MD5 446f11db938cc7625e0895b307f3b747
BLAKE2b-256 3524dff7a4ee60aa8a55c8ef3f27e5791bf25931c08bffd203b19a57d42bfd1e

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