Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nathancooperjones/script-scraper
Lightweight Python parser for film and TV scripts.
https://github.com/nathancooperjones/script-scraper
docker movies python script tv
Last synced: 8 days ago
JSON representation
Lightweight Python parser for film and TV scripts.
- Host: GitHub
- URL: https://github.com/nathancooperjones/script-scraper
- Owner: nathancooperjones
- Created: 2020-05-15T22:53:09.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-04-13T15:25:27.000Z (over 3 years ago)
- Last Synced: 2023-03-08T22:49:42.096Z (over 1 year ago)
- Topics: docker, movies, python, script, tv
- Language: Python
- Homepage:
- Size: 295 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# `script_scraper` - Parser for Film and TV Scripts
[](https://codecov.io/gh/nathancooperjones/script-scraper)
A lightweight Python parser built in my spare time as a potential upgrade to the current tool used by the [Geena Davis Institute's](https://seejane.org) Spell Check for Bias tool.
### Usage
```python
>>> from script_scraper import open_pdf, script_scraper, word_and_sentence_count
>>> # open the PDF file
>>> pdf = open_pdf(path='~/Desktop/Inception.pdf')
>>> # run the analysis
>>> words_spoken = script_scraper(pdf=pdf,
... remove_first_line=False)
>>> # check words spoken for each character
>>> words_spoken['ATTENDANT']
['He was delirious. But he asked for', 'you by name. And...', 'Show him.']
>>> # get word and sentence count for each character
>>> word_count, sentence_count = word_and_sentence_count(words_spoken['ATTENDANT'])
>>> word_count, sentence_count
(13, 3)
```
### Development
Begin by installing [Docker](https://docs.docker.com/install/), if you have not already. Once Docker is running, run development from within the Docker container:
```bash
# build the Docker image
docker build -t script_scraper .
# run the Docker container in interactive mode
docker run \
-it \
--rm \
-v "${PWD}:/script_scraper" \
-p 8888:8888 \
script_scraper /bin/bash
# launch JupyterLab...
jupyter lab --ip 0.0.0.0 --no-browser --allow-root --NotebookApp.token='' --NotebookApp.password=''
# ... or, now in the container, run unit tests, if you'd like
pytest -v --cov-report term --cov=script_scraper
```
### FAQ
_My PDF has a watermark across every page. What can I do?_
By default, these PDFs will _not_ work in `script_scraper`. Here is how I have been able to run these documents through the library:
1. Use a tool such as [this](https://smallpdf.com/pdf-to-word) to convert the PDF to a Word document.
2. Open the document in Word, then save the document in XML format.
3. Open the XML file in a text editor, find-and-replace the watermark text with an empty string.
4. Open the XML file back up in Word.
5. Save the Word document as a PDF for online use.
Now, you can run `script_scraper` on the edited PDF, which no longer should have the watermark.
If you have a better way to deal with this issue (that is hopefully more automated), feel free to make a PR!
### Known Bugs / Issues Progress
- [ ] PDFs with watermarks will NOT work.
- [ ] Dialogue that might span multiple lines with multiple characters separated with a `/` is incorrectly counted and reported as a single character.
- Low priority, might not address in the foreseeable future.
- [X] Character names with slight misspellings are counted as separate characters.
- Addressed in version `0.5.0`
- [X] Dialogue with multiple characters speaking at once (side-by-side type) with sub-groups of characters speaking at once separated with a `/` is incorrectly counted and reported as only two characters.
- Addressed in version `0.4.0`
- [X] Character's with `V.O.` in name are counted as separate characters.
- Addressed in version `0.3.0`
- [X] Dialogue with multiple characters separated with an `AND` or `&` is incorrectly counted and reported as a single character.
- Addressed in version `0.3.0`
- [X] Characters with punctuation are sometimes counted as more than one character.
- Addressed in version `0.3.0`
- [X] Sentence count is not the _most_ reliable yet for some character's dialogue.
- Addressed in version `0.2.2`
- [X] Dialogue with multiple characters separated with a `/` is incorrectly counted and reported as a single character.
- Addressed in version `0.2.0`
- [X] `non_dialogue_sentence` _might_ not be required for `get_character_dialogue_for_page`...
- Addressed in version `0.1.1`
- [X] Sometimes, different scene descriptions are counted as characters.
- Addressed in version `0.2.1`
- [X] When a character speaks in all caps, it is assumed to be a character name.
- Addressed in version `0.1.1`