README.md

Botlet

Communication and commands bot.

Requirements

• Python >=3.7 as code interpreter for all important tasks
• (Optional) git for git plugin
• (Optional) Docker for container building & running

Usage

Preparation

• Use virtual environment:
  • Install: python -m venv .venv
  • Activate (Windows): .venv\Scripts\activate.bat
  • Activate (Linux): source .venv/bin/activate
• Install dependencies: pip install -r requirements.txt -r requirements-dev.txt

Code quality

• Run code linting: pylint botlet
• Run unit tests: coverage run
• Report test coverage: coverage report
  (For other output formats, replace report by html|json|xml)

Deploy

• Show code documentation: pdoc -o html/ botlet
• Manage distribution:
  • Source archive: python setup.py sdist
  • Install locally: pip install .

Run

• Start application:
  • From source: python -m botlet
  • From installation: botlet
• Create docker container:
  • Build image: docker build -t botlet .
  • Run container: docker run -it --name botlet-lives botlet
    (Containers can run with customized environment variables and configuration files in volumes)

Configuration

• Call command line with -h for a help text
• See configuration file formats in botlet.config package (config.ini & logging.ini)
• Environment variables serve as parameters (f.e. secrets for server access)

For more, see plugins.

IDE support

• VSCode with plugins:
  • Python
  • EditorConfig for VS Code
  • Docker
• PyCharm

Contributing

You can help with bug reports or feature ideas by opening issues.
Code contributions should be submitted as merge requests.
Please keep the quality up by checking your changes, using mentioned tools and following conventions.

TODO

Features

• IO by http/rest (alternative to chat)
• Webhook listener (HTTP server):
  • Gitlab
  • Jenkins

Infrastructure

• Gitlab CI