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

Uploaded Source

Built Distribution

Jouvence-0.4.2-py3-none-any.whl (25.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: Jouvence-0.4.2.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.2.tar.gz
Algorithm Hash digest
SHA256 29dfe59fb832500e3666b4e1112c106c663c2804b5922c007b8a471f0f627d6b
MD5 ee2de587725f6cd94d562d48c5fba685
BLAKE2b-256 ae7322631be9be3c3f0e237cf05f19f3b72a206033e7d30ce88e081980577538

See more details on using hashes here.

File details

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

File metadata

  • Download URL: Jouvence-0.4.2-py3-none-any.whl
  • Upload date:
  • Size: 25.0 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2c3dd188f1e5c22563a4b542548cbd8482b57dbf48491f13fab1d919f6bba9df
MD5 c50b96acca311251f19fbffcd4b03edb
BLAKE2b-256 96cf78b900b983ae6d030c11b6f632514dbbdb7db55179ef199608ce05986269

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