Python-based library for accessing the Blues Notehub API.

These details have been verified by PyPI

Project links

Homepage

GitHub Statistics

Maintainers

paigen11 tjvantoll

These details have not been verified by PyPI

Intended Audience
- Developers
License
- OSI Approved :: MIT License
Natural Language
- English
Operating System
- OS Independent
Programming Language

Project description

notehub-py

The OpenAPI definition for the Notehub.io API.

This Python package is automatically generated by the OpenAPI Generator project:

API version: 1.2.0
Package version: 4.0.0
Generator version: 7.5.0
Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://dev.blues.io/support/

Requirements.

Python 3.7+

Installation & Usage

pip install

With pip via PyPy:

python3 -m pip install notehub-py

(you may need to run pip with root permission: sudo python3 -m pip install notehub-py)

python3 -m pip3 install notehub-py

Then import the package:

import notehub_py

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import notehub_py

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import notehub_py
from notehub_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.notefile.net
# See configuration.py for a list of all supported configuration parameters.
configuration = notehub_py.Configuration(
    host = "https://api.notefile.net"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: personalAccessToken
configuration = notehub_py.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.AlertApi(api_client)
    project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | 
    page_size = 50 # int |  (optional) (default to 50)
    page_num = 1 # int |  (optional) (default to 1)
    monitor_uid = 'monitor_uid_example' # str |  (optional)

    try:
        api_response = api_instance.get_alerts(project_or_product_uid, page_size=page_size, page_num=page_num, monitor_uid=monitor_uid)
        print("The response of AlertApi->get_alerts:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AlertApi->get_alerts: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.notefile.net

Class	Method	HTTP request	Description
AlertApi	get_alerts	GET /v1/projects/{projectOrProductUID}/alerts
AuthorizationApi	login	POST /auth/login
AuthorizationApi	o_auth2_client_credentials	POST /oauth2/token	Issue an OAuth 2.0 access token (Client Credentials)
BillingAccountApi	get_billing_accounts	GET /v1/billing-accounts
DeviceApi	add_db_note	POST /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/{noteID}
DeviceApi	add_qi_note	POST /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}
DeviceApi	delete_device	DELETE /v1/projects/{projectOrProductUID}/devices/{deviceUID}
DeviceApi	delete_device_environment_variable	DELETE /v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_variables/{key}
DeviceApi	delete_note	DELETE /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/{noteID}
DeviceApi	delete_notefiles	DELETE /v1/projects/{projectOrProductUID}/devices/{deviceUID}/files
DeviceApi	disable_device	POST /v1/projects/{projectOrProductUID}/devices/{deviceUID}/disable
DeviceApi	disable_device_connectivity_assurance	POST /v1/projects/{projectOrProductUID}/devices/{deviceUID}/disable-connectivity-assurance
DeviceApi	enable_device	POST /v1/projects/{projectOrProductUID}/devices/{deviceUID}/enable
DeviceApi	enable_device_connectivity_assurance	POST /v1/projects/{projectOrProductUID}/devices/{deviceUID}/enable-connectivity-assurance
DeviceApi	get_db_note	GET /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/{noteID}
DeviceApi	get_device	GET /v1/projects/{projectOrProductUID}/devices/{deviceUID}
DeviceApi	get_device_environment_hierarchy	GET /v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_hierarchy	Get environment variable hierarchy for a device
DeviceApi	get_device_environment_variables	GET /v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_variables
DeviceApi	get_device_environment_variables_by_pin	GET /v1/products/{productUID}/devices/{deviceUID}/environment_variables_with_pin
DeviceApi	get_device_health_log	GET /v1/projects/{projectOrProductUID}/devices/{deviceUID}/health-log
DeviceApi	get_device_latest_events	GET /v1/projects/{projectOrProductUID}/devices/{deviceUID}/latest
DeviceApi	get_device_plans	GET /v1/projects/{projectOrProductUID}/devices/{deviceUID}/plans
DeviceApi	get_device_public_key	GET /v1/projects/{projectOrProductUID}/devices/{deviceUID}/public-key
DeviceApi	get_device_public_keys	GET /v1/projects/{projectOrProductUID}/devices/public-keys
DeviceApi	get_device_sessions	GET /v1/projects/{projectOrProductUID}/devices/{deviceUID}/sessions
DeviceApi	get_devices	GET /v1/projects/{projectOrProductUID}/devices
DeviceApi	get_fleet_devices	GET /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/devices
DeviceApi	get_notefile	GET /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}
DeviceApi	list_notefiles	GET /v1/projects/{projectOrProductUID}/devices/{deviceUID}/files
DeviceApi	provision_device	POST /v1/projects/{projectOrProductUID}/devices/{deviceUID}/provision
DeviceApi	set_device_environment_variables	PUT /v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_variables
DeviceApi	set_device_environment_variables_by_pin	PUT /v1/products/{productUID}/devices/{deviceUID}/environment_variables_with_pin
DeviceApi	signal_device	POST /v1/projects/{projectOrProductUID}/devices/{deviceUID}/signal
DeviceApi	update_db_note	PUT /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/{noteID}
EventApi	get_events	GET /v1/projects/{projectOrProductUID}/events
EventApi	get_events_by_cursor	GET /v1/projects/{projectOrProductUID}/events-cursor
EventApi	get_fleet_events	GET /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/events
EventApi	get_fleet_events_by_cursor	GET /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/events-cursor
EventApi	get_route_logs_by_event	GET /v1/projects/{projectOrProductUID}/events/{eventUID}/route-logs
ExternalDevicesApi	create_event_ext_device	POST /v1/products/{productUID}/ext-devices/{deviceUID}/event
ExternalDevicesApi	ext_device_session_close	POST /v1/products/{productUID}/ext-devices/{deviceUID}/session/close
ExternalDevicesApi	ext_device_session_open	POST /v1/products/{productUID}/ext-devices/{deviceUID}/session/open
MonitorApi	create_monitor	POST /v1/projects/{projectOrProductUID}/monitors
MonitorApi	delete_monitor	DELETE /v1/projects/{projectOrProductUID}/monitors/{monitorUID}
MonitorApi	get_monitor	GET /v1/projects/{projectOrProductUID}/monitors/{monitorUID}
MonitorApi	get_monitors	GET /v1/projects/{projectOrProductUID}/monitors
MonitorApi	update_monitor	PUT /v1/projects/{projectOrProductUID}/monitors/{monitorUID}
ProjectApi	add_device_to_fleets	PUT /v1/projects/{projectOrProductUID}/devices/{deviceUID}/fleets
ProjectApi	clone_project	POST /v1/projects/{projectOrProductUID}/clone
ProjectApi	create_fleet	POST /v1/projects/{projectOrProductUID}/fleets
ProjectApi	create_product	POST /v1/projects/{projectOrProductUID}/products
ProjectApi	create_project	POST /v1/projects
ProjectApi	delete_device_from_fleets	DELETE /v1/projects/{projectOrProductUID}/devices/{deviceUID}/fleets
ProjectApi	delete_fleet	DELETE /v1/projects/{projectOrProductUID}/fleets/{fleetUID}
ProjectApi	delete_fleet_environment_variable	DELETE /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_variables/{key}
ProjectApi	delete_product	DELETE /v1/projects/{projectOrProductUID}/products/{productUID}
ProjectApi	delete_project	DELETE /v1/projects/{projectOrProductUID}
ProjectApi	delete_project_environment_variable	DELETE /v1/projects/{projectOrProductUID}/environment_variables/{key}
ProjectApi	disable_global_event_transformation	POST /v1/projects/{projectOrProductUID}/global-transformation/disable
ProjectApi	enable_global_event_transformation	POST /v1/projects/{projectOrProductUID}/global-transformation/enable
ProjectApi	get_device_dfu_history	GET /v1/projects/{projectOrProductUID}/devices/{deviceUID}/dfu/{firmwareType}/history
ProjectApi	get_device_dfu_status	GET /v1/projects/{projectOrProductUID}/devices/{deviceUID}/dfu/{firmwareType}/status
ProjectApi	get_device_fleets	GET /v1/projects/{projectOrProductUID}/devices/{deviceUID}/fleets
ProjectApi	get_devices_dfu_history	GET /v1/projects/{projectOrProductUID}/dfu/{firmwareType}/history
ProjectApi	get_devices_dfu_status	GET /v1/projects/{projectOrProductUID}/dfu/{firmwareType}/status
ProjectApi	get_firmware_info	GET /v1/projects/{projectOrProductUID}/firmware
ProjectApi	get_fleet	GET /v1/projects/{projectOrProductUID}/fleets/{fleetUID}
ProjectApi	get_fleet_environment_hierarchy	GET /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_hierarchy	Get environment variable hierarchy for a device
ProjectApi	get_fleet_environment_variables	GET /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_variables
ProjectApi	get_fleets	GET /v1/projects/{projectOrProductUID}/fleets
ProjectApi	get_notefile_schemas	GET /v1/projects/{projectOrProductUID}/schemas	Get variable format for a notefile
ProjectApi	get_products	GET /v1/projects/{projectOrProductUID}/products
ProjectApi	get_project	GET /v1/projects/{projectOrProductUID}
ProjectApi	get_project_by_product	GET /v1/products/{productUID}/project
ProjectApi	get_project_environment_hierarchy	GET /v1/projects/{projectOrProductUID}/environment_hierarchy	Get environment variable hierarchy for a device
ProjectApi	get_project_environment_variables	GET /v1/projects/{projectOrProductUID}/environment_variables
ProjectApi	get_project_members	GET /v1/projects/{projectOrProductUID}/members
ProjectApi	get_projects	GET /v1/projects
ProjectApi	perform_dfu_action	POST /v1/projects/{projectOrProductUID}/dfu/{firmwareType}/{action}
ProjectApi	set_fleet_environment_variables	PUT /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_variables
ProjectApi	set_global_event_transformation	POST /v1/projects/{projectOrProductUID}/global-transformation
ProjectApi	set_project_environment_variables	PUT /v1/projects/{projectOrProductUID}/environment_variables
ProjectApi	update_fleet	PUT /v1/projects/{projectOrProductUID}/fleets/{fleetUID}
ProjectApi	upload_firmware	PUT /v1/projects/{projectOrProductUID}/firmware/{firmwareType}/{filename}
RouteApi	create_route	POST /v1/projects/{projectOrProductUID}/routes
RouteApi	delete_route	DELETE /v1/projects/{projectOrProductUID}/routes/{routeUID}
RouteApi	get_route	GET /v1/projects/{projectOrProductUID}/routes/{routeUID}
RouteApi	get_route_logs_by_route	GET /v1/projects/{projectOrProductUID}/routes/{routeUID}/route-logs
RouteApi	get_routes	GET /v1/projects/{projectOrProductUID}/routes
RouteApi	update_route	PUT /v1/projects/{projectOrProductUID}/routes/{routeUID}
UsageApi	get_data_usage	GET /v1/projects/{projectOrProductUID}/usage/data
UsageApi	get_events_usage	GET /v1/projects/{projectOrProductUID}/usage/events
UsageApi	get_route_logs_usage	GET /v1/projects/{projectOrProductUID}/usage/route-logs
UsageApi	get_sessions_usage	GET /v1/projects/{projectOrProductUID}/usage/sessions
WebhookApi	create_webhook	POST /v1/projects/{projectOrProductUID}/webhooks/{webhookUID}
WebhookApi	delete_webhook	DELETE /v1/projects/{projectOrProductUID}/webhooks/{webhookUID}
WebhookApi	get_webhook	GET /v1/projects/{projectOrProductUID}/webhooks/{webhookUID}
WebhookApi	get_webhooks	GET /v1/projects/{projectOrProductUID}/webhooks
WebhookApi	update_webhook	PUT /v1/projects/{projectOrProductUID}/webhooks/{webhookUID}

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

personalAccessToken

Type: Bearer authentication

Type: API key
API key parameter name: X-Auth-Token
Location: HTTP header

Author

engineering@blues.io

Project details

These details have been verified by PyPI

Project links

Homepage

GitHub Statistics

Maintainers

paigen11 tjvantoll

These details have not been verified by PyPI

Intended Audience
- Developers
License
- OSI Approved :: MIT License
Natural Language
- English
Operating System
- OS Independent
Programming Language

Release history Release notifications | RSS feed

This version

4.0.0

Dec 16, 2025

3.0.0

Dec 3, 2025

2.3.0

Oct 29, 2025

2.2.1

Oct 29, 2025

2.2.0

Oct 15, 2025

2.1.0

Oct 9, 2025

2.0.0

Sep 24, 2025

1.0.17

Sep 23, 2025

1.0.16

Sep 4, 2025

1.0.15

Jul 30, 2025

1.0.14

Jul 1, 2025

1.0.13

Jun 12, 2025

1.0.12

May 28, 2025

1.0.11

May 21, 2025

1.0.10

May 14, 2025

1.0.9

May 13, 2025

1.0.8

Apr 23, 2025

1.0.7

Mar 21, 2025

1.0.6

Jan 23, 2025

1.0.5

Nov 22, 2024

1.0.4

Nov 14, 2024

1.0.3

Oct 31, 2024

1.0.2

Sep 12, 2024

1.0.1

Aug 26, 2024

1.0.0

Jun 11, 2024

0.0.5

Jun 7, 2024

0.0.4

Jun 6, 2024

0.0.3

May 15, 2024

0.0.2

May 6, 2024

0.0.1

May 3, 2024

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

notehub_py-4.0.0.tar.gz (132.8 kB view details)

Uploaded Dec 16, 2025 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

notehub_py-4.0.0-py3-none-any.whl (267.4 kB view details)

Uploaded Dec 16, 2025 Python 3

File details

Details for the file notehub_py-4.0.0.tar.gz.

File metadata

Download URL: notehub_py-4.0.0.tar.gz
Upload date: Dec 16, 2025
Size: 132.8 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for notehub_py-4.0.0.tar.gz
Algorithm	Hash digest
SHA256	`ac654a431d0036e896a2c3e342b5db5b5a9bf5465cf9c9c0ae34fee3de6c7e80`
MD5	`3287e2b7d39c88b7878f23fa9ed8105a`
BLAKE2b-256	`011326cf5a326f539731647a88d6da10bcfe429fb900d1666520f658e1d21070`

See more details on using hashes here.

Provenance

The following attestation bundles were made for notehub_py-4.0.0.tar.gz:

Publisher: publish-pypi.yml on blues/notehub-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: notehub_py-4.0.0.tar.gz
- Subject digest: ac654a431d0036e896a2c3e342b5db5b5a9bf5465cf9c9c0ae34fee3de6c7e80
- Sigstore transparency entry: 767471057
- Sigstore integration time: Dec 16, 2025
Source repository:
- Permalink: blues/notehub-py@592a1a20bddec145883cd301ff5c75d4b5ff8d66
- Branch / Tag: refs/tags/v4.0.0
- Owner: https://github.com/blues
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish-pypi.yml@592a1a20bddec145883cd301ff5c75d4b5ff8d66
- Trigger Event: release

File details

Details for the file notehub_py-4.0.0-py3-none-any.whl.

File metadata

Download URL: notehub_py-4.0.0-py3-none-any.whl
Upload date: Dec 16, 2025
Size: 267.4 kB
Tags: Python 3
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for notehub_py-4.0.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`54237a89e21409495389a3bb9eba78851629e977f06e54052fe91537f7c0c342`
MD5	`64566417e08c956a23659f2abbba4ea3`
BLAKE2b-256	`3f4684a61b0296789d4260349f03e8494f81acd9262ceeaff6af6406dcf0fecf`

See more details on using hashes here.

Provenance

The following attestation bundles were made for notehub_py-4.0.0-py3-none-any.whl:

Publisher: publish-pypi.yml on blues/notehub-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: notehub_py-4.0.0-py3-none-any.whl
- Subject digest: 54237a89e21409495389a3bb9eba78851629e977f06e54052fe91537f7c0c342
- Sigstore transparency entry: 767471058
- Sigstore integration time: Dec 16, 2025
Source repository:
- Permalink: blues/notehub-py@592a1a20bddec145883cd301ff5c75d4b5ff8d66
- Branch / Tag: refs/tags/v4.0.0
- Owner: https://github.com/blues
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish-pypi.yml@592a1a20bddec145883cd301ff5c75d4b5ff8d66
- Trigger Event: release

notehub-py 4.0.0

Navigation

Verified details

Project links

GitHub Statistics

Maintainers

Unverified details

Meta

Classifiers

Project description

notehub-py

Requirements.

Installation & Usage

pip install

Setuptools

Tests

Getting Started

Documentation for API Endpoints

Documentation For Models

Documentation For Authorization

personalAccessToken

pin

Author

Project details

Verified details

Project links

GitHub Statistics

Maintainers

Unverified details

Meta

Classifiers

Release history Release notifications | RSS feed

Download files

Source Distribution

Built Distribution

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance