jupytercor

permet de convertir les cellules markdown d'un notebook jupyter avec pandoc


Keywords
latex, jupyter, notebook
License
MIT
Install
pip install jupytercor==0.1.10

Documentation

Jupytercor

Jupytercor est un package python qui permet de convertir les cellules markdown d'un notebook jupyter avec pandoc.

Installation et utilisation

Pour installer jupytercor, vous devez avoir python3 et pandoc installés sur votre machine.

Vous pouvez ensuite installer jupytercor avec pip:

pip install --upgrade jupytercor

Pour utiliser jupytercor, vous devez exécuter le script jupytercor.py avec la commande suivante:

jupytercor input.ipynb [-o output.ipynb] [--clean] [--to FORMAT] [--images]

OĂą:

  • input.ipynb est le nom du fichier notebook d'entrĂ©e Ă  convertir
  • -o output.ipynb est une option qui permet de spĂ©cifier le nom du fichier notebook de sortie (par dĂ©faut c'est output.ipynb)
  • --to FORMAT est une option pour prĂ©ciser le format de sortie.
    • --to latex pour convertir en LaTeX.
    • --to pdfpour convertir en PDF.
  • --clean est une option qui permet d'effectuer les conversions avec pandoc (par dĂ©faut c'est False)
  • --images est une option qui permet de tĂ©lĂ©charger les images distantes dans un dossier images (par dĂ©faut c'est False)

Fonctionnalités et options

Jupytercor offre les fonctionnalités et options suivantes:

  • Il lit un fichier notebook au format ipynb et en extrait les cellules markdown
  • Il transforme chaque cellule markdown en html avec pandoc en utilisant l'option -f markdown -t html
  • Il transforme chaque cellule html en markdown avec pandoc en utilisant l'option -f html -t gfm-raw_html
  • Il remplace le contenu des cellules markdown par le texte transformĂ©
  • Il Ă©crit un nouveau fichier notebook au format ipynb avec les cellules converties
  • Il permet Ă  l'utilisateur de choisir le nom du fichier notebook d'entrĂ©e et celui du fichier notebook de sortie
  • Il permet Ă  l'utilisateur d'activer ou non les conversions avec pandoc grâce au drapeau --clean
  • Il permet Ă  l'utilisateur de tĂ©lĂ©charger les images distantes avec une url grâce au drapeau --images

Licence et crédits

Jupytercor est distribué sous la licence MIT.

Jupytercor utilise nbformat pour lire et Ă©crire des fichiers notebooks.

Jupytercor utilise subprocess pour exécuter des commandes pandoc.

Jupytercor utilise argparse pour analyser les arguments passés au script.

Jupytercor s'inspire du code trouvé sur cette page web: https://beautiful-soup-4.readthedocs.io/en/latest/#searching-the-tree