nn-inbox-api 0.1.5

A Python wrapper for the Notesnook Inbox API.

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)

Usage on Windows

Because Windows (and other OSes) may have gpg installed in a non-standard place at times (for example, maybe you use the scoop package manager), this tool now supports passing in a string object in Notesnook_Inbox() creation.

from nn_inbox_api import Notesnook_Inbox
inbox = Notesnook_Inbox(apikey="yourapikey", gpgbinary="/path/to/binary/gpg.exe")

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.