snpvclient 0.1.6

A Python client for connecting to a Supernote Private Cloud Instance.

Supernote Private Cloud Python Client

A Python client for connecting to a Supernote Private Cloud Instance. Useful for automating tasks like uploading content to your Supernote device.

Requires Python 3.10+

Install

pip install snpvclient

Usage and Examples

Setup the client and connect to private cloud.

import snpvclient as sn
snclient = sn.SNPClient( 'https://supernote.example.com' )
snclient.login( '[e-mail]', 'password' )

Get root folder and file list

root_folder = snclient.getList()

Get list of folders and files for a specific id

folder_list = snclient.getList( '78236046000054508' ) # id

Upload a file

upload = snclient.upload(file_path, directoryId)

Delete a file

delete = snclient.delete( 'directoryId', [ 'document id', 'document id' ] )

Get url of rendered PNG of all pages of a .note file.

png = snclient.getPNG( 'document id' )

Get url of all rendered PDF of a .note file. Pass specific page numbers as a list or a blank list for all pages.

pdf = snclient.getPDF( 'document id', [ 'pageNo' ] )

Actions

List all folders and files

sn.actions.list_folder( snclient )

Upload to a specific folder on your device. In this case, it will upload test_file.pdf to Research folder under the main Note folder.

sn.actions.upload_to_folder( snclient, 'test_file.pdf', 'Note/Research')

You can also use the shortcut action to common Supernote folders

sn.actions.upload_to_inbox( snclient, 'test_file.pdf' ) # Inbox
sn.actions.upload_to_document( snclient, 'test_file.pdf' ) # Document
sn.actions.upload_to_note( snclient, 'test_file.pdf' ) # Note