Launch, edit, and share Jupyter notebooks in automation.
Install | Getting Started | Documentation | License | Code of Conduct | Contributing
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.
Python 3.8+
poetry add noteable-origami
pip install noteable-origami
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()
Alternatively you can set the environment variable:
NOTEABLE_TOKEN=xxxx
and skip assigning the token:
async with NoteableClient() as client:
await client.ping_rtu()
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()
See CONTRIBUTING.md.
Open sourced with ❤️ by Noteable for the community.