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()
with open(path_to_output, 'w') as fp:
  renderer.render_doc(document, fp)

Limitations

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

  • Dual dialogue

  • Proper Unicode support (although Fountain’s spec greatly assumes English screenplays, sadly).

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.3.0.tar.gz (17.2 kB view details)

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for Jouvence-0.3.0.tar.gz
Algorithm Hash digest
SHA256 21e21695268e3ca492cd025888d7233afb8759c5d09f6e2582e09739109749e8
MD5 16b85aeafc7a69d3c0bb27b43492878b
BLAKE2b-256 3d40f6a5f874c5a283366fdcdc757fbfc6003754aba8b6615b9a5954b303d8d5

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