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 hashes)

Uploaded Source

Built Distribution

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

Uploaded Python 3

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