# 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:
```bash
pip install --upgrade jupytercor
```
Pour utiliser jupytercor, vous devez exécuter le script jupytercor.py avec la commande suivante:
```bash
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 pdf`pour 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
Raw data
{
"_id": null,
"home_page": "https://github.com/infocornouaille/jupytercor",
"name": "jupytercor",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "latex,jupyter,notebook",
"author": "David Couronn\u00e9",
"author_email": "couronne.david@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/51/94/431152d2b44ab387e19117167dca43cfd12cb894637f448489ec27ce4afc/jupytercor-0.1.10.tar.gz",
"platform": null,
"description": "# Jupytercor\n\nJupytercor est un package python qui permet de convertir les cellules markdown d'un notebook jupyter avec pandoc.\n\n## Installation et utilisation\n\nPour installer jupytercor, vous devez avoir python3 et pandoc install\u00e9s sur votre machine.\n\nVous pouvez ensuite installer jupytercor avec pip:\n\n```bash\npip install --upgrade jupytercor\n```\n\nPour utiliser jupytercor, vous devez ex\u00e9cuter le script jupytercor.py avec la commande suivante:\n\n```bash\njupytercor input.ipynb [-o output.ipynb] [--clean] [--to FORMAT] [--images]\n```\n\nO\u00f9:\n\n- `input.ipynb` est le nom du fichier notebook d'entr\u00e9e \u00e0 convertir\n- `-o output.ipynb` est une option qui permet de sp\u00e9cifier le nom du fichier notebook de sortie (par d\u00e9faut c'est output.ipynb)\n- `--to FORMAT` est une option pour pr\u00e9ciser le format de sortie. \n - `--to latex` pour convertir en LaTeX.\n - `--to pdf`pour convertir en PDF.\n- `--clean` est une option qui permet d'effectuer les conversions avec pandoc (par d\u00e9faut c'est False)\n- `--images` est une option qui permet de t\u00e9l\u00e9charger les images distantes dans un dossier `images` (par d\u00e9faut c'est False)\n\n## Fonctionnalit\u00e9s et options\n\nJupytercor offre les fonctionnalit\u00e9s et options suivantes:\n\n- Il lit un fichier notebook au format ipynb et en extrait les cellules markdown\n- Il transforme chaque cellule markdown en html avec pandoc en utilisant l'option `-f markdown -t html`\n- Il transforme chaque cellule html en markdown avec pandoc en utilisant l'option `-f html -t gfm-raw_html`\n- Il remplace le contenu des cellules markdown par le texte transform\u00e9\n- Il \u00e9crit un nouveau fichier notebook au format ipynb avec les cellules converties\n- Il permet \u00e0 l'utilisateur de choisir le nom du fichier notebook d'entr\u00e9e et celui du fichier notebook de sortie\n- Il permet \u00e0 l'utilisateur d'activer ou non les conversions avec pandoc gr\u00e2ce au drapeau `--clean`\n- Il permet \u00e0 l'utilisateur de t\u00e9l\u00e9charger les images distantes avec une url gr\u00e2ce au drapeau `--images`\n\n## Licence et cr\u00e9dits\n\nJupytercor est distribu\u00e9 sous la licence MIT.\n\nJupytercor utilise nbformat pour lire et \u00e9crire des fichiers notebooks.\n\nJupytercor utilise subprocess pour ex\u00e9cuter des commandes pandoc.\n\nJupytercor utilise argparse pour analyser les arguments pass\u00e9s au script.\n\nJupytercor s'inspire du code trouv\u00e9 sur cette page web: https://beautiful-soup-4.readthedocs.io/en/latest/#searching-the-tree",
"bugtrack_url": null,
"license": "MIT",
"summary": "permet de convertir les cellules markdown d'un notebook jupyter avec pandoc",
"version": "0.1.10",
"split_keywords": [
"latex",
"jupyter",
"notebook"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "edd69a2d379299d05344855b1381b47e0f86631a10ee74d1d8d3af53c350a379",
"md5": "5e950f12c9dbc025d4122c25ba2cb877",
"sha256": "e87b55a41e016e3772e4ab04482a1039f9428826ffc1745e4bd1768dbae196e2"
},
"downloads": -1,
"filename": "jupytercor-0.1.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5e950f12c9dbc025d4122c25ba2cb877",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 23589,
"upload_time": "2023-03-26T07:47:49",
"upload_time_iso_8601": "2023-03-26T07:47:49.979424Z",
"url": "https://files.pythonhosted.org/packages/ed/d6/9a2d379299d05344855b1381b47e0f86631a10ee74d1d8d3af53c350a379/jupytercor-0.1.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5194431152d2b44ab387e19117167dca43cfd12cb894637f448489ec27ce4afc",
"md5": "1256a54682b6d64224252a1604532bb1",
"sha256": "6948de736e5cb6c5cfd9a89bfb458c10dc9a494913db0fa8ace70e4f886a5b28"
},
"downloads": -1,
"filename": "jupytercor-0.1.10.tar.gz",
"has_sig": false,
"md5_digest": "1256a54682b6d64224252a1604532bb1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 24044,
"upload_time": "2023-03-26T07:47:51",
"upload_time_iso_8601": "2023-03-26T07:47:51.294373Z",
"url": "https://files.pythonhosted.org/packages/51/94/431152d2b44ab387e19117167dca43cfd12cb894637f448489ec27ce4afc/jupytercor-0.1.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-26 07:47:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "infocornouaille",
"github_project": "jupytercor",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "jupytercor"
}
JSON
