draw lines package

Aperçu

Un module Python pour dessiner des lignes stylisées et colorées dans le terminal. Cet utilitaire permet la personnalisation des styles de ligne, des couleurs et du positionnement du texte, ce qui en fait un outil polyvalent pour améliorer la sortie des applications CLI.

Caractéristiques

• Positions de texte personnalisables: gauche, droite ou centre.
• Prise en charge de diverses couleurs de texte et styles, notamment en gras.
• Largeur de ligne réglable et rembourrage.
• Utilise colorama pour la gestion des couleurs et du style, assurant la compatibilité entre différents systèmes d'exploitation.

Installation

pip install wolfsoftware.drawlines

Usage

La fonctionnalité principale est fournie par la fonction draw_line , qui peut être utilisée pour créer des lignes dans le terminal avec ou sans texte.

Signature de la fonction

 def draw_line ( text = '' , position = 'center' , fill_char = '-' , pad = 2 , width = - 1 , color = '' ):
    """
    Draw a line across the terminal with optional text.

    Args:
        text (str): Text to include in the line. Defaults to '' (no text).
        position (str): Position of the text ('left', 'right', 'center'). Defaults to 'center'.
        fill_char (str): Character used to fill the line. Defaults to '-'.
        pad (int): Padding characters around the text. Defaults to 2.
        width (int): Total width of the line; defaults to the terminal width if set to -1.
        color (str): Color and style of the text, e.g., 'red', 'blue+bold'. Defaults to no color.
    """

Exemples

1. Ligne simple avec paramètres par défaut

 from your_module import draw_line

# Draw a simple dashed line
print ( draw_line ())

Sortir

------------------------------------------------------------------------------------------

2. Ligne avec texte centré et couleur personnalisée

 # Draw a line with centered text
print ( draw_line ( text = "Hello, World!" , position = 'center' ))

Sortir

------------------------------------- Hello, World ! --------------------------------------

Si vous définissez le fill_char=' ' vous obtiendrez simplement du texte centré sans ligne.

3. Ligne avec texte aligné gauche et caractère de remplissage personnalisé

 # Draw a line with left-aligned text and asterisk fill character
print ( draw_line ( text = "Left aligned text" , position = 'left' , fill_char = '*' ))

Sortir

 ** Left aligned text ********************************************************************* 

Personnalisation

Cette section fournit des détails sur la façon dont vous pouvez personnaliser les paramètres de fonction draw_line . Vous trouverez ci-dessous une table répertoriant chaque paramètre, sa valeur par défaut, ses valeurs et ses valeurs autorisées:

Nom	Valeur par défaut	But	Valeurs autorisées
texte	''	Toute chaîne que vous souhaitez afficher dans la ligne.	N'importe quelle chaîne
position	'centre'	Où placer le texte.	«gauche», «centre», «droite»
fill_char	'-'	Le caractère à utiliser lors du dessin de la ligne. Si plus d'un est donné, seul le premier est utilisé.	Tout caractère unique
Left_pad	2	Combien de fill_chars utiliser comme préfixe lors de l'alignement du texte à gauche.	Tout entier positif
right_pad	2	Combien de fill_chars utiliser comme postfix lors de l'alignement du texte correctement.	Tout entier positif
largeur	-1	Quelle largeur pour tracer la ligne. Par défaut, la largeur du terminal moins une si elle n'est pas spécifiée.	Tout entier; -1 pour la largeur du terminal moins 1
couleur	''	Quelle couleur pour faire du texte.	«Bold», «noir», «bleu», «cyan», «vert», «gris», «magenta», `` rouge »,« blanc »,« jaune »,« noir + bold »,« bleu + gras »,« cyan + bold »,« vert + bold »,« gris + bold »,« jaune + bold », rouge + bold», «blanc + bold», «jaune + bold», rouge + bold »,« Blanche + Bold »,« Yellow + Bold », rouge + bold», «Blanche + Bold», «Yellow + Bold».
audacieux	FAUX	Si le texte est audacieux. Cela peut être utilisé avec ou sans couleur définie.	Vrai, faux

Si vous ajoutez audacieux à une couleur, il doit venir après le nom de la couleur. EB cyan + gras et non gras + cyan car cela entraînera une exception.