Skip to content

Latest commit

 

History

History
51 lines (37 loc) · 2.31 KB

README.md

File metadata and controls

51 lines (37 loc) · 2.31 KB

Binary Coffee Bot

Telegram bot that publishes the latest articles from our blog to our Telegram channel. If you have a blog with a json1 feed and want to send the posts automatically to a telegram channel you can use this bot.

Setup project

Environment variables

  • Telegram variables
    • TELEGRAM_CHANNEL: your telegram channel @channel
    • TELEGRAM_TOKEN: your telegram bot token, you can see this post
  • Twitter variables
    • TWITTER_CONSUMER_KEY: your twitter consumer key
    • TWITTER_CONSUMER_SECRET: your twitter consumer secret
    • TWITTER_ACCESS_TOKEN: your twitter access token
    • TWITTER_ACCESS_TOKEN_SECRET: your twitter access token secret
  • Application variables
    • RSS_FEED: URL of the JSON feed of your blog. Example https://api.binary-coffee.dev/posts/feed/json1
    • REFRESH_TIME: interval of time to check for new items. Default 60
    • DATA_ADAPTER: type of adapter used to save the data. Example MemoryAdapter|JsonAdapter|MongodbAdapter
    • DATA_PATH: (JsonAdapter) in case of use JsonAdapter, you can decide where to save the file. Default ./data.
    • DATABASE_HOST: (MongodbAdapter) host for your mongodb database. Default localhost
    • DATABASE_PORT: (MongodbAdapter) port for your mongodb database. Default 27017
    • DATABASE_NAME: (MongodbAdapter) database name. default bc_db

Steps to start the bot

  1. Clone the repo: git clone https://github.com/dcs-community/binarycoffee_bot.git
  2. Create environment: virtualenv -p python3 env
  3. Activate environment: source env/bin/activate
  4. Set environment variables
  5. Install packages: pip install -r requirements.txt
  6. Finally, run python bot.py

Deploy in Heroku

See this post for help.

Setup with docker

  1. Clone the repo: git clone https://github.com/dcs-community/binarycoffee_bot.git
  2. Set environment variables
  3. Start docker-compose: docker-compose up -d

Contribution

Any contribution is welcome.

License

Check our LICENCE.md file.