.. _examplepyquickhelperrst:

=====================
example pyquickhelper
=====================


.. only:: html

    **Links:** :download:`notebook <example_pyquickhelper.ipynb>`, :downloadlink:`html <example_pyquickhelper2html.html>`, :download:`PDF <example_pyquickhelper.pdf>`, :download:`python <example_pyquickhelper.py>`, :downloadlink:`slides <example_pyquickhelper.slides.html>`, :githublink:`GitHub|_doc/notebooks/example_pyquickhelper.ipynb|*`


Explore a folder, run a command line from a notebook.

.. code:: ipython3

    from jyquickhelper import add_notebook_menu
    add_notebook_menu(header="Plan")






.. contents::
    :local:





Log, run_cmd
~~~~~~~~~~~~

The function
`fLOG <http://www.xavierdupre.fr/app/pyquickhelper/helpsphinx/pyquickhelper/loghelper/flog.html?highlight=flog>`__
prints information on the standard output and in a file *temp_log.txt*:

.. code:: ipython3

    from pyquickhelper.loghelper import fLOG
    fLOG(OutputPrint=False)  # by default
    fLOG("not printed")
    fLOG(OutputPrint=True)
    fLOG("printed")


.. parsed-literal::
    2020-02-20 09:59:47 
    2020-02-20 09:59:47 printed


The function
`run_cmd <http://www.xavierdupre.fr/app/pyquickhelper/helpsphinx/pyquickhelper/loghelper/flog.html?highlight=run_cmd#loghelper.flog.run_cmd>`__
runs a command line and returns the standard output and error:

.. code:: ipython3

    from pyquickhelper.loghelper import run_cmd
    out,err=run_cmd("help", wait=True, shell=True)
    print(out)


.. parsed-literal::
    Pour plus d'informations sur une commande spcifique, entrez HELP
    suivi de la commande.
    ASSOC          Affiche ou modifie les applications associes aux extensions de
                   fichiers.
    ATTRIB         Affiche ou modifie les attributs d'un fichier.
    BREAK          Active ou dsactive le contrle tendu de CTRL+C.
    BCDEDIT        Dfinit les proprits dans la base de donnes de dmarrage pour
                   le contrle du chargement d'amorage.
    CACLS          Affiche ou modifie les listes de contrles d'accs aux fichiers.
    CALL           Appelle un fichier de commandes  partir d'un autre fichier de
                   commandes.
    CD             Modifie le rpertoire ou affiche le rpertoire actif.
    CHCP           Modifie ou affiche le numro de la page de code active.
    CHDIR          Modifie le rpertoire ou affiche le nom du rpertoire actif.
    CHKDSK         Vrifie un disque et affiche un rapport d'tat.
    CHKNTFS        Affiche ou modifie la vrification du disque au dmarrage.
    CLS            Efface l'cran.
    CMD            Excute une nouvelle instance de l'interprteur de commandes de
                   Windows.
    COLOR          Modifie les couleurs du premier plan et de l'arrire-plan de la
                   console.
    COMP           Compare les contenus de deux fichiers ou groupes de fichiers.
    COMPACT        Modifie ou affiche la compression des fichiers sur une
                   partition NTFS.
    CONVERT        Convertit des volumes FAT en volumes NTFS. Vous ne pouvez pas
                   convertir le lecteur en cours d'utilisation.
    COPY           Copie un ou plusieurs fichiers.
    DATE           Affiche ou dfinit la date.
    DEL            Supprime un ou plusieurs fichiers.
    DIR            Affiche la liste des fichiers et des sous-rpertoires d'un
                   rpertoire.
    DISKPART       Affiche ou configure les proprits d'une partition de disque.
    DOSKEY         Modifie les lignes de commande, rappelle des commandes Windows,
                   et cre des macros.
    DRIVERQUERY    Affiche l'tat et les proprits du pilote de priphrique en
                   cours d'utilisation.
    ECHO           Affiche des messages ou active/dsactive l'affichage des
                   commandes.
    ENDLOCAL       Stoppe la localisation des modifications d'environnement dans
                   un fichier de commandes.
    ERASE          Supprime un ou plusieurs fichiers.
    EXIT           Quitte l'interprteur de commandes (CMD.EXE).
    FC             Compare deux fichiers ou groupes de fichiers et affiche 
                   les diffrences.
    FIND           Recherche une chane de caractres dans un ou plusieurs
                   fichiers.
    FINDSTR        Cherche des chanes dans les fichiers.
    FOR            Excute une commande sur chaque fichier d'un ensemble de
                   fichiers.
    FORMAT         Formate un disque devant tre utilis avec Windows.
    FSUTIL         Affiche ou configure les proprits du systme de fichiers.
    FTYPE          Affiche ou modifie les types de fichiers utiliss dans les
                   associations d'extensions.
    GOTO           Indique l'excution d'un fichier de commandes pour une ligne
                   identifie par une tiquette.
    GPRESULT       Affiche les informations de stratgie de groupe pour un
                   ordinateur ou un utilisateur.
    GRAFTABL       Permet  Windows d'afficher un jeu de caractres en 
                   mode graphique.
    HELP           Affiche des informations sur les commandes de Windows.
    ICACLS         Afficher, modifier, sauvegarder ou restaurer les listes de
                   contrle d'accs pour les fichiers et les rpertoires.
    IF             Effectue un traitement conditionnel dans un fichier de
                   commandes.
    LABEL          Cre, modifie ou supprime le nom de volume d'un disque.
    MD             Cre un rpertoire.
    MKDIR          Cre un rpertoire.
    MKLINK         Crer des liens symboliques et des liens physiques
    MODE           Configure un priphrique du systme.
    MORE           Affiche la sortie cran par cran.
    MOVE           Dplace un ou plusieurs fichiers d'un rpertoire 
                    un autre.
    OPENFILES      Affiche les fichiers partags ouverts  distance par les
                   utilisateurs.
    PATH           Affiche ou dfinit le chemin de recherche des fichiers
                   excutables.
    PAUSE          Interrompt l'excution d'un fichier de commandes et affiche un
                   message.
    POPD           Restaure la valeur prcdente du rpertoire actif enregistre
                   par PUSHD.
    PRINT          Imprime un fichier texte.
    PROMPT         Modifie l'invite de commande de Windows.
    PUSHD          Enregistre le rpertoire actif puis le modifie.
    RD             Supprime un rpertoire.
    RECOVER        Rcupre l'information lisible d'un disque dfectueux.
    REM            Insre un commentaire dans un fichier de commandes ou
                   CONFIG.SYS.
    REN            Renomme un ou plusieurs fichiers.
    RENAME         Renomme un ou plusieurs fichiers.
    REPLACE        Remplace des fichiers.
    RMDIR          Supprime un rpertoire.
    ROBOCOPY       Utilitaire avanc pour copier les fichiers et les
                   arborescences de rpertoires
    SET            Affiche, dfinit ou supprime des variables d'environnement
                   Windows.
    SETLOCAL       Commence la localisation des modifications d'environnement dans
                   un fichier de commandes.
    SC             Affiche ou configure les services (processus en arrire-plan).
    SCHTASKS       Planifie les commandes et les programmes  excuter sur
                   l'ordinateur.
    SHIFT          Modifie la position des paramtres remplaables dans un fichier
                   de commandes.
    SHUTDOWN       Permet un arrt local ou distant correct de l'ordinateur.
    SORT           Trie les entres.
    START          Ouvre une fentre spare pour l'excution d'un programme ou
                   d'une commande spcifique.
    SUBST          Associe un chemin d'accs  une lettre de lecteur.
    SYSTEMINFO     Affiche les proprits et la configuration spcifiques de
                   l'ordinateur.
    TASKLIST       Affiche toutes les tches en cours d'excution, y compris les
                   services.
    TASKKILL       Termine ou interrompt un processus ou une application en cours
                   d'excution.
    TIME           Affiche ou dfinit l'heure du systme.
    TITLE          Dfinit le titre de la fentre pour une session CMD.EXE.
    TREE           Affiche le graphisme de la structure de rpertoire d'un lecteur
                   ou d'un chemin d'accs.
    TYPE           Affiche le contenu d'un fichier texte.
    VER            Affiche la version de Windows.
    VERIFY         Demande  Windows de vrifier si vos fichiers sont
                   correctement crits sur le disque.
    VOL            Affiche le nom et le numro de srie d'un volume de disque.
    XCOPY          Copie les fichiers et les arborescences de rpertoires.
    WMIC           Affiche les informations WMI dans l'interface de commande
                   interactive.
    Pour obtenir plus d'informations sur les outils, consultez la rfrence de
    commande en ligne dans l'aide en ligne.
    


Ask something to the user in a notebook
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code:: ipython3

    from pyquickhelper.ipythonhelper import open_html_form
    params= {"module":"", "version":"v..."}
    open_html_form(params, "fill the fields", "form1")






.. raw:: html

    <div style="background-color:gainsboro; padding:2px; border:0px;"><b>fill the fields</b>
    <br />module <input type="text" id="form1module" value="" size="80" />
    <br />version <input type="text" id="form1version" value="v..." size="80" />
    <br /><button onclick="set_valueform1()">Ok</button></div>
    <script type="text/Javascript">
    function form1callback(msg) {
       var ret = msg.content.data['text/plain'];
       $('#outform1').text(ret);
    }
    function set_valueform1(){
       command='form1 = {' ;
       var form1modulevar_value = document.getElementById('form1module').value;
       command += '"module":"' + form1modulevar_value + '",';
       var form1versionvar_value = document.getElementById('form1version').value;
       command += '"version":"' + form1versionvar_value + '",';
       command += '}';
       var kernel = IPython.notebook.kernel;
       kernel.execute(command);
    }
    </script>



.. code:: ipython3

    form1




.. parsed-literal::
    {'module': '', 'version': 'v...'}



Explore a folder
~~~~~~~~~~~~~~~~

.. code:: ipython3

    from jyquickhelper.helper_in_notebook import set_notebook_name_theNotebook
    set_notebook_name_theNotebook()



.. parsed-literal::
    <IPython.core.display.Javascript object>




.. parsed-literal::

    <IPython.core.display.Javascript object>



.. code:: ipython3

    import os
    path = os.path.join(os.path.abspath(os.path.dirname(theNotebook)), "..")

.. code:: ipython3

    from pyquickhelper.filehelper import explore_folder
    d,f =explore_folder(path)
    [ os.path.split(_)[-1] for _ in f[:5]]




.. parsed-literal::
    ['environment.yml',
     'plot_sync.py',
     'README.txt',
     'set_jenkins_jobs.py',
     'check_matplotlib_backend.ipynb']