Skip to content

Latest commit

 

History

History
58 lines (41 loc) · 3.4 KB

README.md

File metadata and controls

58 lines (41 loc) · 3.4 KB
Raw

Movie Quote Twitter Bot tag Build Status codecov

Example GIF

This is a Python script I made one day after work, it will pick random quotes from a provided movie and post them to Twitter and Mastodon as animated GIFs.

Requeriments

  • python3.7
  • pipenv

Installation

Clone the project, navigate to its root folder and execute pipenv install for installing it's dependencies.

Configuration

To execute the script the following environment variables must be set.

  • TWITTER_ENABLED: If set to true posting to Twitter will be enabled.
  • TWITTER_CONSUMER_KEY: Your Twitter account consumer key.
  • TWITTER_CONSUMER_SECRET: Your Twitter account consumer secret.
  • TWITTER_ACCESS_TOKEN_KEY: Your Twitter account access token key.
  • TWITTER_ACCESS_TOKEN_SECRET: Your Twitter account access token secret.
  • MASTODON_ENABLED: If set to true posting to Mastodon will be enabled.
  • MASTODON_CLIENT_ID: Client id for your Mastodon instance.
  • MASTODON_CLIENT_SECRET: Client secret for your Mastodon instance.
  • MASTODON_API_BASE_URL: Base url for your Mastodon instance.
  • MASTODON_LOGIN: Login (username) for the account that will post in Mastodon.
  • MASTODON_PASSWORD: Password for the account that will post in Mastodon.
  • SUBS_URI: Path of the .srt subs file. e.g. /home/user/movies/movie.srt
  • SUBS_ENCODING: Encoding of the subs file. e.g. utf-8-sig, latin-1, etc...
  • VIDEO_URI: Path of the actual movie file. e.g. /home/users/movies/movie.mkv
  • OUTPUT_URI: Path where the GIF file that will be posted is stored. e.g. /tmp/movie.gif
  • TEXT_COLOR: Color for the text that will be displayed e.g. yellow, white, etc...
  • TEXT_SIZE: Font size for the text that will be displayed e.g. 18
  • TEXT_FONT: Font for the text that will be displayed e.g. FreeSans-Negrita
  • IDLE_PERIOD: The number of seconds the script will wait before executing. e.g. 900
  • SENTRY_URL: If set errors will be sent to Sentry.

Usage

Just execute pipenv run python main.py and if everything is properly configured, a random movie quote will be posted to your Twitter and Mastodon accounts.

Testing

For executing the tests just execute pipenv run pytest on the project's root folder.

Docker deployment

A Docker image for a containerized development is included, when the container is running the bot will keep posting gifs. Find it on DockerHub.

Contributing

Any suggestion, bug reports, or any other kind enhacements are welcome. Just open an issue first for creating a PR remember this project has linting checkings so any PR should comply with them before beign merged, this checks will be automatically applied when opening or modifying the PR's.