The Noteable API interface
Project description
Origami
A library capturing message patterns and protocols speaking to Noteable's APIs
Install | Getting Started | License | Code of Conduct | Contributing
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. You can use the platform 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.
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()
Contributing
See CONTRIBUTING.md.
Open sourced with ❤️ by Noteable for the community.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file noteable_origami-0.0.20.tar.gz.
File metadata
- Download URL: noteable_origami-0.0.20.tar.gz
- Upload date:
- Size: 34.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.4.0 CPython/3.10.2 Linux/5.15.0-1033-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8a53c69b26763df9ab288db782fe7f1e94a1317571d3aa0f665927ce55d575d9 |
|
| MD5 | 0cd890d57acf9719179e6e51840d1c5f |
|
| BLAKE2b-256 | 5156a2906faf204032bf5f14f95f9b42b171e9145b3285fb018c0a8843d6438b |
File details
Details for the file noteable_origami-0.0.20-py3-none-any.whl.
File metadata
- Download URL: noteable_origami-0.0.20-py3-none-any.whl
- Upload date:
- Size: 39.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.4.0 CPython/3.10.2 Linux/5.15.0-1033-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9f759980ae920975b346dfca37ef60a326cebe335020420285300eba59a5db23 |
|
| MD5 | 7af97c65fa0bdd4b2b630f0d8d4c3819 |
|
| BLAKE2b-256 | 96c97c17d398601dfe4ba970de3669c030194d1856c945f0d953e4041345a501 |
