Skip to content

A twitter bot that notifies you just before AtCoder contest.

License

Notifications You must be signed in to change notification settings

todokku/AtCoderChokuZen

 
 

Repository files navigation

AtCoderChokuZen

Build Status codecov Issues Pull Requests License: MIT

Description

A twitter bot that notifies you just before AtCoder contest. The purpose is to reduce the number of times you forget to join contests. The bot was inspired by tweets.

DEMO

Sample tweet

Features

  • Notify you to participate at regular intervals when the day of the contest comes.

Usage

  • Just click on the follow button on twitter.

How to clone the repository

Paste the following commands at a Terminal prompt.

$ mkdir hoge
$ cd hoge
$ git clone git@github.com:KATO-Hiro/AtCoderChokuZen.git

Set up Twitter API in local env

  1. Sign into your Twitter account, and apply for a developer account.

  2. After being approved, click "Create an app", and input App info. Next, click "Key and tokens" tab and "Create" button, you can get "Consumer API Keys" and "Access token info".

Note: The above keys give access to your Twitter account. Keep it confidential and never store them in this repository.

  1. Create .env files or copy .env.sample as .env.
$ touch .env

Open your editor, filling in your Twitter keys like below. XXXXX means your "Consumer API Keys" or "Access token info".

CONSUMER_KEY=XXXXX
CONSUMER_SECRET=XXXXX
ACCESS_TOKEN=XXXXX
ACCESS_SECRET=XXXXX

Note that .env file is in the project's .gitignore, so it won't be checked into this repository.

See

https://qiita.com/kngsym2018/items/2524d21455aac111cdee

https://qiita.com/hedgehoCrow/items/2fd56ebea463e7fc0f5b

Debug in your local env

Paste the following commands at a Terminal prompt in your cloned directory.

# Setup container
$ docker-compose build

# Run container
$ docker-compose up -d

# Stop container
$ docker-compose stop

# Run a command
$ docker-compose run --rm web hogehoge

Requirement

  • Docker Desktop 19+
  • Python 3.8.x
  • pip

Test framework and CI

Hosting

  • Heroku

Optional

Links

AtCoder

Original tweet

Readme Driven Development; RDD

Author

@KATO-Hiro

License

MIT

About

A twitter bot that notifies you just before AtCoder contest.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 97.5%
  • Dockerfile 2.1%
  • Shell 0.4%