Skip to main content

A simple tool to convert Jupyter notebooks to PDF

Project description

JupyterToPDF

JupyterToPDF is a Python package designed to simplify the process of converting Jupyter notebooks (.ipynb files) into PDF documents. This tool aims to provide an easy and automated way for users to generate PDFs from their Jupyter notebooks, either saving them in the same directory as the notebook or in a specified output directory.

Features

  • Convert Jupyter notebooks to PDF with a single function call.
  • Option to specify the output directory for the generated PDF.
  • Simple and easy to use, integrating seamlessly with your Jupyter workflow.

Installation

Install JupyterToPDF using pip:

pip install JupyterToPDF

Dependencies

  • pdfkit: Used for the conversion process.
  • wkhtmltopdf: A command-line tool required by pdfkit for converting HTML to PDF. Make sure it's installed on your system. It can be downloaded from wkhtmltopdf.org.

Usage

Here's how to use JupyterToPDF:

from JupyterToPDF import convert_notebook_to_pdf

Convert a notebook to PDF and save in a specific output folder

convert_notebook_to_pdf('path/to/notebook.ipynb', 'path/to/output/folder')

Save the PDF in the same folder as the notebook

convert_notebook_to_pdf('path/to/notebook.ipynb')

License

JupyterToPDF is open-source software licensed under the MIT License.

Author

Nayeem Islam

Contributing

Contributions to JupyterToPDF are welcome! If you're interested in helping to improve the project, please read the contributing guidelines to get started.

  • Ensure your code adheres to the project's standards.
  • Include tests for new functionality.
  • Document any changes or improvements.

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

JupyterToPDF-0.0.1.tar.gz (3.1 kB view details)

Uploaded Source

Built Distribution

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

JupyterToPDF-0.0.1-py3-none-any.whl (3.8 kB view details)

Uploaded Python 3

File details

Details for the file JupyterToPDF-0.0.1.tar.gz.

File metadata

  • Download URL: JupyterToPDF-0.0.1.tar.gz
  • Upload date:
  • Size: 3.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for JupyterToPDF-0.0.1.tar.gz
Algorithm Hash digest
SHA256 5349dc2b528a9e14ad3d925654fef42420f38c10fdebda91429c59e3304bfff2
MD5 ba8364aaf119baae8d166df5334b1eeb
BLAKE2b-256 f4873d90177fbf442090b4651e02c0ea7c4412ff05a6fa643acfa2626465bc18

See more details on using hashes here.

File details

Details for the file JupyterToPDF-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: JupyterToPDF-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 3.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for JupyterToPDF-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e48e7d46fa576178a9dd35d78d56f0286765acf322c7fe89d62b52b72083ae69
MD5 97822e85d16c4daf030b00ed78b0a30f
BLAKE2b-256 126d81786beaece136555fe6d76b249ac6fe2ffa7c2f3d1d1b0210c8b21dbca7

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