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

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for Jouvence-0.2.0.tar.gz
Algorithm Hash digest
SHA256 e4632cbf9c2585464f0459dd68307b93dbed061dff3b888536b9d8093271a3e9
MD5 fd1a63226ecfd16d3e361777788ec6e5
BLAKE2b-256 4720525a81f98f2ea47c7606348837dcea8253c8bab77e12451e8aed277bbb31

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