KKlochko
/
dots-matrix-bot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
44 Commits
1 Branch
0 Tags
106 KiB
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'main'
${ noResults }
Go to file
KKlochko c12b94633e
continuous-integration/drone/push Build is passing Details
Add the CHANGELOG. 		2 years ago
src Update the config class for the dots bot api. 2 years ago
tests Remove the method to get name and count for 'addItem' command. 2 years ago
.dockerignore Update dockerignore, gitignore files. 2 years ago
.drone.yaml Fixed the CI/CD configuration by adding all deps. 2 years ago
.gitignore Update dockerignore, gitignore files. 2 years ago
CHANGELOG.org Add the CHANGELOG. 2 years ago
COPYING Add license. 2 years ago
Dockerfile Initial commit 2 years ago
README.rst Update the README. 2 years ago
config.toml Initial commit 2 years ago
dev_requirements.txt Update requirements files. 2 years ago
docker-compose.yaml Update docker-compose file to run src.main as package. 2 years ago
pyproject.toml Add license. 2 years ago
requirements.txt Update requirements files. 2 years ago

README.rst 

dots-matrix-bot
===============

dots-matrix-bot is the interface for
`dots-bot-api <https://gitlab.com/KKlochko/dots-bot-api/>`__ to have
access to `Dots Platform Clients API <https://docs.dots.live/>`__ using
matrix.

Setup
=====

-  setup `dots-bot-api <https://gitlab.com/KKlochko/dots-bot-api/>`__,
   before continue.

-  clone this repository.

-  create ``.env``. Example:

   .. code::

      USERNAME=@example:example.com
      PASSWORD=password
      SERVER=https://example.com
      BOT_API_BASE_URL=https://domain

-  change the ``config.toml``: `more about allowlist and blocklist
   formats <https://simple-matrix-bot-lib.readthedocs.io/en/latest/examples.html#id2>`__
   Example:

   .. code:: toml

      [simplematrixbotlib.config]
      allowlist = []
      blocklist = []
      admin_id = '@admin:example.com'

-  check that dots-bot-api is accessible, if it works then you can
   continue.

-  change base url in ``src/config/dots_bot_api_config.py``: Example:

   .. code:: python

      _base_url = "https://dotsapi.server.com"

-  run ``sudo docker-compose up -d`` in the project folder.

-  run ``sudo docker ps`` to see that ``dots_matrix_bot`` is run.

-  Now you can add bot to your chat and run commands.

Template
========

dots-matrix-bot uses
`simplematrixbotlib\ template <https://github.com/foresle/simplematrixbotlib_template>`__.

Author
======

Kostiantyn Klochko (c) 2023

License
=======

Under the GNU Affero General Public License v3.0 or later.