maaack / screenplayreader

Tool for reading files in screenplay formats and parsing their structure.

Screenplay Reader

A tool for reading files in screenplay formats and parsing their structure.

Basic Idea

Upload a screenplay in .txt, .pdf, .fdx, and so on and get it parsed into the different recognizable parts of a screenplay. Get the output through the REST framework, or alternative future methods.

What does it do right now?

Input

Takes plaintext of a screenplay, where newlines separate distinct sections (ie. location, character, action, dialogue)

Output

Outputs a csv of one scene per row, marking characters present.

Scene Number	Location	Character #1	Character #2	Character #3	Character #4
1	Crime Scene	X
2	Police Station		X	X
3	Hideout				X

How To Run

Requirements

• docker
• docker-machine

Setup

1. Navigate into the base folder.

2. Run docker-compose up

3. 🔥🔥🔥

4. You'll need to run migrations on the database to get it caught up.

   $> sudo docker exec -it screenplayreader_web_1 /bin/bash
   timekeeper_web_1$> python manage.py makemigrations
   timekeeper_web_1$> python manage.py migrate
   

5. Open your browser to localhost.

Usage

Importing Content

1. Visit the Importer app API root.
2. Send a POST request of your content to the ImportedContent endpoint.

Parsing Content

1. Visit the Importer app API root.
2. Create a new ParseOperation and run the operation.

Interpreting Content

1. Visit the Interpreter app API root.
2. Create a new InterpretOperation and run the operation.

Exporting Content

1. Visit the Exporter app API root.
2. Navigate to a Screenplay created by the Interpreter.
3. Download Basics CSV or Character Breakout CSV.

Structure

Django-based site with REST API framework

• screenplayreader - Django project
  • importer - Django application
  • interpreter - Django application
  • exporter - Django application

Additional Resources

• Writing your first Django App Tutorials
• Django REST framework Documentation
• REST API Quick Tips
• API Cheatsheet