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.13.tar.gz (26.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jupytercor-0.1.13-py3-none-any.whl (23.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: jupytercor-0.1.13.tar.gz
  • Upload date:
  • Size: 26.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.9 Darwin/24.3.0

File hashes

Hashes for jupytercor-0.1.13.tar.gz
Algorithm Hash digest
SHA256 e4c93649c14223d70578d2920bd0bb988bbd58b079d540b84c462336025c23ee
MD5 798bd6635985fd47c88bb1a3b5399b5f
BLAKE2b-256 d7a8cc63e43514d99647f3b3d92a269c6c4cd149908df44235f6904450bbd9bb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: jupytercor-0.1.13-py3-none-any.whl
  • Upload date:
  • Size: 23.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.9 Darwin/24.3.0

File hashes

Hashes for jupytercor-0.1.13-py3-none-any.whl
Algorithm Hash digest
SHA256 d4d353457720d99236bd592d6ad175f0a4de946dfc4c0b09b1b1301ee9fb1979
MD5 461b7a678923f4f86268ae72d9eae418
BLAKE2b-256 300c1c93b21b1a86f2e103b09d92ed03a6b131116009e347f1c00840ed8b1e97

See more details on using hashes here.

Supported by

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