Skip to content

A reddit bot that runs on the r/bjj subreddit translating Japanese judo techniques names to English.

License

Notifications You must be signed in to change notification settings

AbundantSalmon/judo-techniques-bot

Repository files navigation

Judo Techniques Bot

Translating since - 2019-06-03 Run Python Tests

This is a reddit bot that runs on the r/bjj and r/Ju_Jutsu subreddits. It translates the Japanese names of judo techniques into their commons english names and provides links to videos of those techniques.

Stats can be found at: https://judo-techniques-bot-stats.vercel.app/

Stack

  • Python
  • PostgreSQL
  • SQLAlchemy
    • Alembic
  • Docker

Todo

  • Optimise some of the variant name checking
  • Setup local development database docker

Development FAQ

Run

python3 -m judo_techniques_bot

With local development db:

# Startup docker with database, bot and adminer
docker-compose up

# Load fixture data into the db
python judo_techniques_bot/load_data.py

or

docker exec --env-file .env judo_techniques_bot python judo_techniques_bot/load_data.py

Tests

# See test coverage
coverage run -m unittest
coverage report

# run tests
python3 -m unittest

Database

Generate Migration

alembic revision --autogenerate -m "message"

Run Migration

alembic upgrade head

Any unrun migrations will be run automatically when the bot is started.

Production FAQ

Built when there is commit pushed to main using github actions and deployed as docker container to an EC2 instance on AWS ECS using terraform.

Currently the container is deployed to a portainer instance on a VPS.

About

A reddit bot that runs on the r/bjj subreddit translating Japanese judo techniques names to English.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages