🐍 Client Python

Pré-requis

Si vous n’avez pas installé de daemon, merci de suivre la section 🚀 Quickstart.

Avant de commencer, vérifiez bien que vous avez une instance du daemon Olvid qui tourne, avec une identité créée dessus, et une clé client valide pour vous connecter en utilisant cette identité.

Si vous souhaitez vérifier que votre daemon est fonctionnel et/ou récupérer une clé client perdue, utilisez la commande : docker compose run --rm cli key get

Installation

Nous avons développé une librairie Python qui permet d’interagir facilement avec votre daemon. Elle est disponible à l’installation avec la commande pip.

pip3 install olvid-bot

Astuce

Le module olvid-bot nécessite une version de Python supérieure ou égale à 3.10. Sur Mac OS, nous vous conseillons d’utiliser HomeBrew pour installer une version plus récente.

brew install python3

Configuration

Pour vous connecter au daemon, votre programme a besoin d’une clé client. Cette clé peut être passée à votre programme en utilisant soit une variable d’environnement, soit un fichier .env.

Fichier .env

Créez un fichier .env en utilisant la commande suivante. Rappelez-vous que ce fichier doit être dans le répertoire courant lorsque vous lancez votre programme.

echo OLVID_CLIENT_KEY=ReplaceWithYourClientKey > .env

Variable d’environnement

Il est également possible d’exporter votre clé en tant que variable d’environnement. Dans ce cas, il faut penser à l’exporter à chaque nouvelle session shell.

export OLVID_CLIENT_KEY=ReplaceWithYourClientKey

Premier programme

Afin de vérifier que tout fonctionne correctement, vous pouvez copier/coller ce programme dans un fichier main.py.

import asyncio
from olvid import OlvidClient

async def main():
    client = OlvidClient()
    print((await client.identity_get()).display_name)

asyncio.set_event_loop(asyncio.new_event_loop())
asyncio.get_event_loop().run_until_complete(main())

Vous pouvez ensuite l’exécuter à l’aide de l’interpréteur Python.

python3 main.py

Si tout a bien été configuré, vous devriez voir s’afficher le nom d’usage de l’identité que vous avez créée sur le daemon.

Sinon, rendez-vous dans notre section 👩‍🔧 Dépannage.

Premier Bot

Pour commencer à coder votre premier bot, vous pouvez partir de l’exemple suivant. Il se contente de répondre à chaque message avec le même message, mais il peut facilement être modifié et amélioré.

import asyncio
from olvid import OlvidClient, datatypes, tools

class EchoBot(OlvidClient):
    async def on_message_received(self, message: datatypes.Message):
        await message.reply(message.body)

    async def on_discussion_new(self, discussion: datatypes.Discussion):
        await discussion.post_message("Hello 👋")

async def main():
    bot = EchoBot()
    tools.AutoInvitationBot()  # automatically accept presentation and group invitations
    await bot.run_forever()

asyncio.set_event_loop(asyncio.new_event_loop())
asyncio.get_event_loop().run_until_complete(main())

Et maintenant ?

Pour en apprendre plus sur l’utilisation de notre librairie Python rendez-vous dans notre section 👩‍🏫 Tutoriels. Sinon rendez-vous dans la section 🌱 Exemples pour déployer des projets clés en main.