Skip to main content

A Python wrapper for the Notesnook Inbox API.

Project description

A Python Handler for the Notesnook Inbox API.

Features

  • Encrypts items locally before they leave your machine.
  • Supports self-hosted notesnook servers, even those that do not host an Inbox API server. (This library replaces the need to use the Inbox API server.)
  • Supports multiple Notesnook accounts & servers at once.

Installation

Installation via pip is simple:

pip install nn-inbox-api

Usage

from nn_inbox_api import Notesnook_Inbox
inbox = Notesnook_Inbox(apikey="yourapikey")
inbox_on_selfhosted = Notesnook_Inbox(apikey="yourapikey",server="https://nn-api-server.your-server.tld/inbox/") # the sync server has the functionality to allow users to send pre-encrypted messages at the /inbox/ endpoint.

##########
# The most basic create note is shown below:
# create_note("Title", "Content (html)", "Note Source")
# A full list of attributes is available here: https://help.notesnook.com/inbox-api/getting-started#3-send-data-to-the-inbox

# A realistic example of a note might be...
inbox.create_note("Title", "<h1>Paragraphs are cool!</h1><p>I'm a paragraph!</p>", "from the nn-inbox-api python script", archived=True)

Sending Large Content to Notesnook.

This tool allows you to send slightly more content to Notesnook (About 12 megabytes of text) than the official Inbox server would allow normally. This may result in items being discarded, rejected by the server, or you being unable to sync these items after opening them in Notesnook. You should try to stay within the recommended 10 megabyte limit, but I won't stop items that are slightly over this limit from being sent to Notesnook. Do so at your own risk.

Project details


Download files

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

Source Distribution

nn_inbox_api-0.1.4.tar.gz (15.9 kB view details)

Uploaded Source

Built Distribution

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

nn_inbox_api-0.1.4-py3-none-any.whl (16.1 kB view details)

Uploaded Python 3

File details

Details for the file nn_inbox_api-0.1.4.tar.gz.

File metadata

  • Download URL: nn_inbox_api-0.1.4.tar.gz
  • Upload date:
  • Size: 15.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for nn_inbox_api-0.1.4.tar.gz
Algorithm Hash digest
SHA256 fe93981d4f105183008cf4d4d0a8ad0283e301abdd384e64b39a010e4cbfbfd7
MD5 88a92f404084ed46deb5e6059b05a779
BLAKE2b-256 9177b64055b6c515e59ee8bc52c94e0804217c1d2a9b71e1cb6a3ce48b7e369d

See more details on using hashes here.

File details

Details for the file nn_inbox_api-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: nn_inbox_api-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 16.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for nn_inbox_api-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 93bcf26076f8c983a38dca3eb25f1deeda39d8b43f31b742107ff6ba8cb34ed6
MD5 70438ad0feb4c30a3065989fd480e104
BLAKE2b-256 95d989747ced1e856cc3475a6cc26c7707d179a84e0b7f2b2ed60ba4888512b1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page