Skip to content
Tele.push
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
telepush
tests
.env.example
.gitignore
.travis.yml
LICENSE
README.md
conftest.py
pytest.ini
requirements-dev.txt
requirements.txt

README.md

Telepush.py

Build Status Test Coverage

An opensource version of the retired ethbot service. Currently under development.

Setup for development / debugging

  • First of all you should get a domain name;
  • Create a bot via Telegram BotFather
    • Get the bot token;
    • Set bot domain via BotFather;
  • Clone this project and setup environment
    • Setup Python 3 (>= 3.6) environment;
    • Install requirements: pip install -r requirements.txt;
    • Copy the sample config file cp .env.example .env;
    • Edit .env file, fill in your config values;
  • Optionally you can run the test suite:
    • Install development requirements: pip install -r requirements-dev.txt;
    • Run tests: pytest -v;
  • Start
    • export QUART_APP=telepush.app:app;
    • quart run
  • Visit your domain and login with Telegram;

If you run this project on your local machine (e.g. when during development), you can use localtunnel or other alternatives to setup reverse proxy for your domain. Serveo is the recommended alternative.

Notice

The above instructions are only for development / testing purpose. Instructions for setting up a production instance will be available once the code is fully tested. (As you can see with pytest --cov=telepush --cov-report=html, the test coverage is not very high.)

Contribute

Welcome. Please remember to write tests for added lines.

You can’t perform that action at this time.