Embed Templator

Templatateur intégré

Un gestionnaire de modèle Python pour votre Discord Bot pour garder vos intégres simples et cohérentes

Installation

Utilisez la commande suivante pour installer un flux intégré dans votre environnement Python:

pip install Embed-Templator

n'a pas fonctionné?

Selon votre installation Python, vous devrez peut-être utiliser l'un des éléments suivants.

Pip n'est pas sur le chemin mais Python est

python -m pip install embed-templator

Python n'est pas sur le chemin

path/to/python.exe -m pip install embed-templator

En utilisant plusieurs versions Python

py -m pip install embed-templator

Usage

Le plus simple

La façon la plus simple d'utiliser le Templator intégré dans votre projet est la suivante:

 from embed_templator import Embed

# Loading your client instance withing the embed templator.
Embed . load ( client )


@ client . command ()
async def ping ( ctx ):
    # Use it like a regular Embed.
    await ctx . send ( embed = Embed ( description = 'pong!' ))

Contexte intégrés

Cependant, le Templator intégré peut avoir une utilisation plus avancée et utiliser des intérêts de contexte.

 from embed_templator import Embed

client = ...

# Note that auto_author requires the ctx to be passed at embeds init.
Embed . load ( client , auto_author = True )


@ client . command ()
async def ping ( ctx ):
    # Use it like a regular Embed.
    await ctx . send ( embed = Embed ( ctx )( description = 'pong!' ))

Rouages

Si vous utilisez un système basé sur COG, n'oubliez pas d'initialiser l'intégration dans vos COG avec les suivants:

 class MyBeautifulCog ( commands . Cog ):

    def __init__ ( self , client ):
        self . client = client
        
        Embed . load ( self . client )

Ensuite, vous pourrez l'utiliser comme les exemples précédents:

    @ commands . command ()
    async def my ( self , ctx ):

        await ctx . send (
            embed = Embed ( ctx )( description = "Cabbage" )
        )

Utilisation avancée

Si vous souhaitez une configuration intégrée avancée, vous pouvez créer une classe d'intégration personnalisée qui héritera du Templator intégré.

 from __future__ import annotations
import embed_templator


class Embed ( embed_templator . Embed ):
    
    def setup ( self ) -> Embed :
        return self . set_footer (
            text = f" { self . ctx . command } | more info @ { self . ctx . prefix } help"
        )

---

Vous pouvez également utiliser la méthode «mise à jour» pour les derniers modifications dans l'intégration, mieux elle sera envoyée.

❗	Cet exemple utilise un CTX personnalisé qui a le temps de suivi!

 from __future__ import annotations
import embed_templator


class Embed ( embed_templator . Embed ):

    def setup ( self ) -> Embed :
        return self . set_author (
            name = f"Requested by { self . ctx . author } " ,
            icon_url = self . ctx . author . avatar_url
        )

    def update ( self ) -> Embed :
        self . set_footer (
            icon_url = self . client . user . avatar_url ,
            text = '   ' . join (
                (
                    f" { self . ctx . time . elapsed () } " ,
                    f"⏳ { self . client . latency } " ,
                    f"? { self . ctx . prefix } help" ,
                )
            )
        )

        return self

---

Merci d'avoir utilisé le templateur intégré!

Licence

© 2020 copyright Edhyjox

Ce référentiel est concédé sous licence MIT. Voir la licence pour plus de détails.