Origami

Launch, edit, and share Jupyter notebooks in automation.

---

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

Intro to Origami

Origami is a 🐍 Python library for talking to Noteable notebooks. This is the official way to access the full breadth of API calls and access patterns in async Python for rich programmatic access to notebooks. You can use Noteable for free with a quick signup.

Requirements

Python 3.8+

Installation

Poetry

poetry add noteable-origami

Pip

pip install noteable-origami

Getting Started

Get your API token from Noteable within user settings. Within user settings, go to the API Token page, and generate a new token.

from origami.client import NoteableClient

token = ''  # Your API token from Noteable

# Establish a connection to the realtime API
async with NoteableClient(api_token=token) as client:
    await client.ping_rtu()

Token via Environment Variable

Alternatively you can set the environment variable:

NOTEABLE_TOKEN=xxxx

and skip assigning the token:

async with NoteableClient() as client:
    await client.ping_rtu()

Custom Domain

NOTEABLE_TOKEN=xxxx
NOTEABLE_DOMAIN=app.noteable.io

And the client will use that particular domain, for custom deployment location. This value defaults to app.noteable.io.

async with NoteableClient() as client:
    await client.ping_rtu()

Contributing

See CONTRIBUTING.md.

---

Open sourced with ❤️ by Noteable for the community.