Metadata-Version: 2.1
Name: zpp-args
Version: 1.0.1
Summary: Module pour le traitement des arguments d'une ligne de commande
Home-page: https://github.com/ZephyrOff/py-zpp_args
Author: ZephyrOff
Author-email: contact@apajak.fr
License: MIT
Description: # zpp-args
        ## Informations
        Module pour le traitement des arguments d'une ligne de commande.
        <br>Trois sources possibles:
        - sys.argv
        - une chaîne de caractère
        - une liste
        
        ### Prérequis
        - Python 3
        <br>
        
        # Installation
        ```console
        pip install zpp_args
        ```
        
        # Utilisation
        ### Conseil d'importation du module
        ```python
        from zpp_args import parser
        ```
        <br>
        
        ### Initialisation du parser
        ```python
        parse = parser(SOURCE, error_lock=False)
        ```
        >En paramètre supplémentaire, nous pouvons mettre:<br/>
        >- error_lock: Purge le retour de la fonction si une erreur s'est produite (Par défaut: False)
        <br>
        
        ### Initialisation des paramètres
        ```python
        parse.set_parameter(NAME)
        ```
        L'initialisation doit prendre au moins un des deux paramètres suivants:
        - shortcut: Pour les paramètres courts (1 caractère)
        - longname: Pour les paramètres explicites (1 mot ou ensemble de mots séparés par le symbole \_)
        
        _Si non précisé, la fonction initialise shortcut_
        
        >En paramètre supplémentaire, nous pouvons mettre:<br/>
        >- error_lock: Purge le retour de la fonction si une erreur s'est produite (Par défaut: )
        >- type: Pour forcer le paramètre reçu à un str ou un digit (Par défaut: None)
        >- default: Pour choisir une valeur par défaut(Par défaut: None)
        >- description: Pour ajouter une description au paramètre à afficher lors de l'appel de la commande help(Par défaut: None)
        >- required: Choisir si ce paramètre est nécessaire (Par défaut: False)
        >- store: Choisir si le paramètre est un simple True/False ou s'il attends une variable (Par défaut: bool)
        <br>
        
        ### Execution du parseur
        ```python
        argument, parameter = parse.load()
        ```
        Retourne une liste avec les arguments et un dictionnaire avec les paramètres
        
        <br>
        
        ### Initialisation de la description de la commande
        ```python
        parse.set_description(DESCRIPTION)
        ```
        <br>
        
        ### Affichage de l'aide
        ```python
        parse.help()
        ```
Keywords: terminal args zephyroff
Platform: ALL
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
