Skip to main content

telegram-bot-deploy is a simple script that perform continuous deployment for a Telegram bot.

Project description

telegram-bot-deploy

telegram-bot-deploy is simple and easy-to-use script that perform continuous deployment for the Telegram bots.

Installation

You can install telegram-bot-deploy from PyPi:

pip install telegram-bot-deploy

or from GitHub:

pip install https://github.com/ciotto/telegram-bot-deploy/archive/master.zip

How to use

You can use telegram-bot-deploy with the command tbd -u git@github.com:your/repo.git.

There are many configurable parameters. You can see all configuration using command tbd -h.

Is also possible to use environments variables or a .env file in order to set basic configuration.

The available variables are:

  • REPO_URL: The format for Python logging

  • REPO_PATH: The level for Python logging

  • BRANCH: The filename for Python logging

  • SSH_KEY: The URL of the repo to be used

  • CHAT_ID: The local path of the repo

  • BOT_TOKEN: The branch used for deploy

  • MSG_TEXT: Restart also same versions

  • PID_FILE_PATH: The SSH key to be used to authenticate to the repo

  • PYTHON_EXECUTABLE: The chat ID used for bot communication

  • VIRTUALENV_PATH: The bot token used for bot communication

  • CREATE_VIRTUALENV: The message that will be sent after update

  • REQUIREMENTS_PATH: The path to the PID file

  • INSTALL_REQUIREMENTS: The Python executable

  • RUN_TESTS: The path to the Python virtualenv

  • RUN_BOT: The command used in order to create the Python virtualenv

  • LOGGING_FORMAT: The path to the requirements file

  • LOGGING_LEVEL: The command used in order to install the requirements

  • LOGGING_FILENAME: The command used in order to run the tests

How to contribute

This is not a big library but if you want to contribute is very easy!

  1. clone the repository git clone https://github.com/ciotto/telegram-bot-deploy.git
  2. install all requirements make init
  3. do your fixes or add new awesome features (with tests)
  4. run the tests make test
  5. commit in new branch and make a pull request

You chan use telegram-bot-deploy development version with the command python -m bot_ci.


License

Released under MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

telegram-bot-deploy-0.1.0-3.tar.gz (6.9 kB view details)

Uploaded Source

File details

Details for the file telegram-bot-deploy-0.1.0-3.tar.gz.

File metadata

  • Download URL: telegram-bot-deploy-0.1.0-3.tar.gz
  • Upload date:
  • Size: 6.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.7

File hashes

Hashes for telegram-bot-deploy-0.1.0-3.tar.gz
Algorithm Hash digest
SHA256 bc935c532bff6df6d32aae46a0b7657b20724c8fe340e6228aefadb040c0c5b3
MD5 6d97b0a7eb4d7f328b4f70053149eff8
BLAKE2b-256 b98ffe11751758d3e6d82742fe0aa21a0c560ae4384b2c536424c04d5b444aa7

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page