The noteable API interface

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for MSeal from gravatar.com MSeal Avatar for noteable-administrator from gravatar.com noteable-administrator

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: BSD License (BSD-3-Clause)
  • Author: Matt Seal
  • Maintainer: Matt Seal
  • Tags notebook, api, noteable
  • Requires: Python >=3.8, <4.0
Classifiers
Report project as malware

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

Supported by

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