eriol
/
poetrybot
1
0
Fork 0
Code Packages Releases Activity

Use `` for blockquotes
continuous-integration/drone/push Build is passing Details

This commit is contained in:
Daniele Tricoli 2021-04-20 01:29:29 +02:00
parent c737dfc379
commit b48b0f56b7
1 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.rst
View File

@ -7,7 +7,7 @@ Python and it is released under the EUPL 1.2 license.
Friends are defined by an allow list in which every account have to be in order
to to use the bot.
The management of the bot is provided by a REST API defined in the subpackage
`poetrybot.web`.
``poetrybot.web``.
Installation
@ -29,9 +29,9 @@ Installation
export DATABASE_URL=sqlite:////absolute/path/to/poetrybot.db
export TELEGRAM_TOKEN=<telegram bot API key>
`AUTH_TOKEN` is used to authenticate to the REST API used to manage the
bot. Full specification is in the `docs/openapi.yml` file.
Just create a long enough random string, for example using `pwgen -sy 50`.
``AUTH_TOKEN`` is used to authenticate to the REST API used to manage the
bot. Full specification is in the ``docs/openapi.yml`` file.
Just create a long enough random string, for example using ``pwgen -sy 50``.
4. Launch the bot:
.. code-block::
@ -48,22 +48,22 @@ Installation
to look at the API is to load the API specification into
https://editor.swagger.io
An alternative is to clone the repository and use the provided `Dockerfile`.
An alternative is to clone the repository and use the provided ``Dockerfile``.
Usage
-----
To use the bot you only have to use the `/quote` command. The bot can be added
to one or more channels but it's not required. But remember that only friends
in allow list will be able to interact with the bot.
To use the bot you only have to use the ``/quote`` command. The bot can be
added to one or more channels but it's not required. But remember that only
friends in allow list will be able to interact with the bot.
The `/quote` command used without arguments will make the bot to quote a random
poem, but optionally the author and the argument can be specified:
The ``/quote`` command used without parameters will make the bot to quote a
random poem, but optionally the author and the argument can be specified:
* `/quote` returns a random poem;
* `/quote AUTHOR` returns a random poem by `AUTHOR`.
* ``/quote`` returns a random poem;
* ``/quote AUTHOR`` returns a random poem by ``AUTHOR``.
`AUTHOR` is the name or part of the name of the poet case insensitive:
``AUTHOR`` is the name or part of the name of the poet case insensitive:
.. code-block::
@ -73,9 +73,9 @@ poem, but optionally the author and the argument can be specified:
will return a random poem by Giovanni Pascoli, if you don't have another
poet with *ascol* inside the name;
* `/quote AUTHOR about ARGUMENT` returns a random poem by `AUTHOR` about
`ARGUMENT`.
* ``/quote AUTHOR about ARGUMENT`` returns a random poem by ``AUTHOR`` about
``ARGUMENT``.
`ARGUMENT` is, like `AUTHOR`, case insensitive and can be part of a word.
`about` is, instead, case sensitive;
* `/quote about ARGUMENT` returns a random poem about `ARGUMENT`.
``ARGUMENT`` is, like ``AUTHOR``, case insensitive and can be part of a word.
``about`` is, instead, case sensitive;
* ``/quote about ARGUMENT`` returns a random poem about ``ARGUMENT``.