Skip to main content

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

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupytercor-0.1.10.tar.gz (24.0 kB view details)

Uploaded Source

Built Distribution

jupytercor-0.1.10-py3-none-any.whl (23.6 kB view details)

Uploaded Python 3

File details

Details for the file jupytercor-0.1.10.tar.gz.

File metadata

  • Download URL: jupytercor-0.1.10.tar.gz
  • Upload date:
  • Size: 24.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.1 CPython/3.8.16 Darwin/22.3.0

File hashes

Hashes for jupytercor-0.1.10.tar.gz
Algorithm Hash digest
SHA256 6948de736e5cb6c5cfd9a89bfb458c10dc9a494913db0fa8ace70e4f886a5b28
MD5 1256a54682b6d64224252a1604532bb1
BLAKE2b-256 5194431152d2b44ab387e19117167dca43cfd12cb894637f448489ec27ce4afc

See more details on using hashes here.

File details

Details for the file jupytercor-0.1.10-py3-none-any.whl.

File metadata

  • Download URL: jupytercor-0.1.10-py3-none-any.whl
  • Upload date:
  • Size: 23.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.1 CPython/3.8.16 Darwin/22.3.0

File hashes

Hashes for jupytercor-0.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 e87b55a41e016e3772e4ab04482a1039f9428826ffc1745e4bd1768dbae196e2
MD5 5e950f12c9dbc025d4122c25ba2cb877
BLAKE2b-256 edd69a2d379299d05344855b1381b47e0f86631a10ee74d1d8d3af53c350a379

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page