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

Origami

A library capturing message patterns and protocols speaking to Noteable's APIs

CI codecov code coverage PyPI - License PyPI - Python Version PyPI Code style: black

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

--8<-- [start:intro]

Intro to Origami

Origami is our paper folding library for talking to Noteable notebooks. This is where we describe the full breadth of API calls and access patterns in async Python for rich programmatic access to the platform.

--8<-- [end:intro]

--8<-- [start:requirements]

Requirements

Python 3.8+

--8<-- [end:requirements]

--8<-- [start:install]

Installation

Poetry

poetry add noteable-origami

Pip

pip install noteable-origami

--8<-- [end:install]

--8<-- [start:start]

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.

Copy the value

from origami.client import NoteableClient

token = 'ey...' # Your user API token
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()

--8<-- [end:start]

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