Skip to main content

The noteable API interface

Project description

papermill-origami

A papermill engine for running Noteable notebooks

CI PyPI - License PyPI - Python Version PyPI Code style: black


Install | Getting Started | License | Code of Conduct | Contributing

Requirements

Python 3.8+

Installation

Poetry

poetry add papermill-origami

Pip

pip install papermill-origami

Getting Started

Get your access token from https://app.noteable.world/api/token

import papermill as pm
from papermill_origami import NoteableClient, ClientConfig

domain = 'app.noteable.world'
token = 'ey...'
file_id = '...'

async with NoteableClient(token, config=ClientConfig(domain=domain)) as client:
    file = await client.get_notebook(file_id)
    pm.execute_notebook(
        f'noteable://{file_id}',
        None,
        engine_name='noteable', # exclude this kwarg to run the Notebook locally
        # Noteable-specific kwargs
        file=file,
        client=client,
    )

Contributing

See CONTRIBUTING.md.


Open sourced with ❤️ by Noteable for the community.

Boost Data Collaboration with Notebooks

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

papermill-origami-0.0.5.tar.gz (19.8 kB view hashes)

Uploaded Source

Built Distribution

papermill_origami-0.0.5-py3-none-any.whl (23.6 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