screenplain 0.12.0

Convert text file to viewable screenplay.

About Screenplain

You're a hacker. The command line is your home. You know tools like grep, sed and Git inside out. You have formed a symbiotic relationship with your text editor. Those tools are powerful in the right hands. But you're also a screenwriter. Screenwriting is much like programming. It's about structure and form, and -- obviously -- about reading, writing and modifying huge amounts of text. You don't want to use software that lacks the power of your hacking tools just because you're writing a screenplay instead of a shell script.

Enter Screenplain.

Screenplain allows you to write a screenplay as a plain text file using a format called Fountain. Text files are simple and supported by all text manipulation software. It's not just for hackers, too. The simplicity of plain text allows you to easily view and edit them on devices such as tablets and phones. No need for specific screenwriting software.

The magic that Screenplain performs is to take your plain text file and convert it to a good looking screenplay in an industry standard format. Send that file off to your producer, agent, director or screenwriting competition. The supported output formats are FDX, HTML, and PDF.

Screenplain can be used as a command-line application or a library. An Online version of Screenplain is also available.

Installing

pip install screenplain

Usage

Convert a Fountain screenplay to PDF:

screenplain screenplay.fountain screenplay.pdf

Convert to HTML:

screenplain screenplay.fountain screenplay.html

Convert to Final Draft (FDX):

screenplain screenplay.fountain screenplay.fdx

The output format is automatically determined from the output filename extension. If the output filename is omitted, Screenplain will write to standard output. As there is no output filename, you have to specify which format to output, e.g.:

screenplain --format=fdx screenplay.fountain

Credits

Screenplain was coded by Martin Vilcans.

The CSS code that formats Screenplain's HTML output as something that looks as much as a printed screenplay as is possible in HTML was created by Jonathan Poritsky.

The Fountain file format is the result of a collaboration between Stu Maschwitz and John August.

License

Screenplain is released under the MIT license.

Developing

Install uv, e.g. using pip:

python -m pip install uv

Running using uv

After this, run the working copy of the code with:

uv run screenplain

For example:

uv run screenplain screenplay.fountain screenplay.html

Activating virtual environment

As an alternative, you may activate the virtual environment, which makes screenplain available on your PATH:

uv venv  # create .venv unless it already exists
source .venv/bin/activate

After this, you can simply run the command screenplain to run the working copy of the code, e.g.:

uv run screenplain screenplay.fountain screenplay.html

Testing

To run unit tests and style checks, run:

bin/test

To compare reference files with the actual output for pdf format, run:

tests/visual/pdf_test.py

This requires diff-pdf to be installed.