Screenplay PDF to JSON Converter
Description
After years of trying to convert screenplay PDFs to a machine-readable format consistently using Final Draft and PDF Python tools, we decided to create our own screenplay PDF to JSON converter using OpenAI vision transformers. The results are much more reliable for our purposes.
The package converts a Screenplay PDF into a JSON file using the OpenAI API, returns JSON and writes it to a local file whose name is the screenplay filename.json. The process currently costs about 50 cents via the OpenAI API to convert an hour-long pilot, but will no doubt go down in price exponentially over time.
Below is an example of the JSON structure output to file:
[
{
"type": "dialogue",
"name": "JOHN",
"modifier": "(V.O.)",
"content": "Hello, how are you?",
"page": 1
},
{
"type": "action",
"content": "John walks into the room.",
"page": 3
},
{
"type": "dialogue",
"name": "MARY",
"modifier": "(smiling)",
"content": "I'm good, thank you!",
"page": 4
},
{
"type": "dialogue",
"name": "JOHN",
"content": "That's great to hear.",
"page": 4
},
{
"type": "scene",
"content": "INT. LIVING ROOM - DAY",
"page": 5
}
]
Getting Started
Installation
pip install screenplay-pdf-to-json-openai
OpenAI
You will need to provide your own OpenAI key. Follow the instructions here.
Known Issues
- Because it uses a statistical model, sometimes split action lines will be combined into a single JSON Action element and sometimes into multiple Action elements.
- If slug-lines are used WITHOUT INT and EXT then their behaviour is unpredictable but easily detectable.
Quickstart
1. Convert Whole Screenplay and Save to JSON File
from screenplay_pdf_to_json import ScreenplayPDFToJSON
sptj = ScreenplayPDFToJSON(api_key=<your_openai_key>)
data = sptj.convert('TheEmpireStrikesBack.pdf')
2. Convert First 3 Pages of a Screenplay and Save to JSON File
from screenplay_pdf_to_json import ScreenplayPDFToJSON
sptj = ScreenplayPDFToJSON(api_key=<your_openai_key>)
data = sptj.convert('TheEmpireStrikesBack.pdf', end_page=3)
3. Estimate Cost of Converting a Screenplay
from screenplay_pdf_to_json import ScreenplayPDFToJSON
sptj = ScreenplayPDFToJSON(api_key=<your_openai_key>)
cost = sptj.estimate_cost('TheEmpireStrikesBack.pdf')
print(f"Estimated cost to convert screenplay: ${cost:.2f}")
4. Convert Screenplay with No Title Page and Save to JSON File
from screenplay_pdf_to_json import ScreenplayPDFToJSON
sptj = ScreenplayPDFToJSON(api_key=KEY, skip_title_page=False)
data3 = sptj.convert('screenplay_with_no_title_page.pdf')
Metadata
Release files for screenplay-to-json-openai 1.0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| screenplay_to_json_openai-1.0.3.tar.gz | 6.6 kB | Without provenance | Details for screenplay_to_json_openai-1.0.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| screenplay_to_json_openai-1.0.3-py3-none-any.whl | Python 3 | none | any | Details for screenplay_to_json_openai-1.0.3-py3-none-any.whl |
Total release size: 13.7 kB
Release files / screenplay_to_json_openai-1.0.3.tar.gz
| Download URL | screenplay_to_json_openai-1.0.3.tar.gz |
|---|---|
| Size | 6.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
377eb22170a23195e202395a47e8e28965a17a9a96ebff0d6122c95e7e095aab
|
|
BLAKE2b-256 checksum How to use checksums |
08a2c27873853f68eb74a75d208790f0d10002196bbf87045ad49086ece8449c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.0 CPython/3.10.4
|
Release files / screenplay_to_json_openai-1.0.3-py3-none-any.whl
| Download URL | screenplay_to_json_openai-1.0.3-py3-none-any.whl |
|---|---|
| Size | 7.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8a3934ee9b70fa853274b1c039087aff9e5b3e227a6d95e36918ed53628d1b54
|
|
BLAKE2b-256 checksum How to use checksums |
6d5d31982d2b16f7867380b0b74fd2b5a64b4a295e45f8c586b34ccffb8916e8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.0 CPython/3.10.4
|
Security for screenplay-to-json-openai 1.0.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.