maxbroome / prompty

Automatically import a Google Document into a teleprompter web interface!

Automatically import a google document into a web-based teleprompter app!

Teleprompter interface screenshot

🚨 This is super barebones, and not recomened for production! 🚨

Web interface is a modifed version from Peter Schmalfeldt

📝 Requirements

• Python 3.9 or later

• Pip

🚀 Installing

Copy the project to your system using Git or downloading and extracting the zip file.

Using Git

git clone https://github.com/MaxBroome/prompty.git

Then naviagate to the prompty directory.

Installing the necessary packages for the Python script

pip install -r requirements.txt

Getting our Google Cloud Platform service account

1. Log in to console.cloud.google.com
2. Go to APIs & Services
3. Create a new credential in the "Credentials" tab
4. Choose a Service Account for the type of credential, and Viewer for the role
5. Click Done
6. Navigate to the Service Account you just created, click on the keys tab, anc create a new key in JSON
7. Download it to your machine, open it, and copy it's contents to your clipboard

Now that we have our GCP credentials, we can go back to the prompty folder.

8. Create a file called creds.json in the main directory
9. Paste the previously copied data into that file and save it

Go back to the GCP Console and copy the email address for the service account

The Service Account email address should look like [email protected]

10. Open the Google Document you wish to import to prompty
11. Click the share tab; and share the document with the Service Account email address, with viewer permissions
12. While you're still at the Google Document, copy the Document ID from the URL. It should look like this docs.google.com/document/d/DOCUMENT_ID/edit
13. Open the get-script.py file and replace <GOOGLE DOCUMENT ID> with your own Document ID
14. Save the edited Python script

You're done! 🎉

✨ Using Prompty

1. Run the get-script.py Python script

python3 get-script.py

2. Inside of the web-interface folder, open index.html in your favorite web browser

That's it!

Warning

The teleprompter web interface does not automatically update after you have ran the script again. So to see the updated version of the Google Doc after you have ran the python script, you can just refresh the tab.

Tip

If you need the text flipped either horizontally or vertically (shuch as use on a teleprompter). You can do this by editing the defaultConfig variable in web-interface/assets/js/script.v122.js and changing flipX or flipy to true.

👷 What's next

• Dockerizing the entire thing 🐋
• Auto-updating web interface
• A button or hotkey to run the Python 'get' script in the backround, and update the text