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:

  • 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.4.1.tar.gz (1.9 MB view details)

Uploaded Source

Built Distribution

Jouvence-0.4.1-py3-none-any.whl (24.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: Jouvence-0.4.1.tar.gz
  • Upload date:
  • Size: 1.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.3

File hashes

Hashes for Jouvence-0.4.1.tar.gz
Algorithm Hash digest
SHA256 48b82de407a716d96dc8c2c37448fd22e9f34d152285a632f6d08e25d9f122ad
MD5 431ecdde3c419918d776390d6a3fde9a
BLAKE2b-256 242afd4a09f0420e0230acfcc5549228abcb5d9b892b4c85b92f134fced4135d

See more details on using hashes here.

File details

Details for the file Jouvence-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: Jouvence-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 24.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.3

File hashes

Hashes for Jouvence-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 76c2caa3b5827bfd53728d1d0f4369841d68d4d3621baf913c111e304f8b5d6e
MD5 1da790a0276f50f38af1c1e0c07952dc
BLAKE2b-256 1982e9ff9acf1989c550fa8011cf6c0c31f82fdfe3fe1eaf55939f2a8bcd14ec

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