🐍 📖 Joplin API
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
joplin_api update docstring Jan 17, 2019
.gitignore Initial commit Sep 26, 2018
LICENSE Initial commit Sep 26, 2018
MANIFEST.in Create MANIFEST.in Jan 15, 2019
README.md Update README.md Jan 17, 2019
requirements-dev.txt Create requirements-dev.txt Jan 15, 2019
requirements.txt upd security of requirements Oct 30, 2018
setup.cfg Update setup.cfg Jan 15, 2019
setup.py introducing setup.cfg Dec 25, 2018
test.py fix path to checkout Jan 15, 2019
tox.ini Create tox.ini Jan 15, 2019

README.md

Joplin Api

The API of Joplin Editor in Python 3.6+

## requirements

Installation

git clone  https://github.com/foxmask/joplin-api
cd joplin-api 
pip install -e .

Using Joplin API

>>> from joplin_api import JoplinApi
>>> joplin = JoplinApi(token='the token provided by Joplin in the WebClipper menu:P'))
>>> joplin.ping()  # to check if the service is up
>>> joplin.get_folders() # to get all the folders
>>> folder_title = 'Default'
>>> folder = joplin.create_folder(folder_title) # to create a folder
>>> folder_id = folder.json()['id']
>>> # to create a new note
>>> note_title = 'My title'
>>> note_body = '# My Title ## My Subtitle my body'
>>> joplin.create_note(note_title, note_body, folder_id)
>>> joplin.get_notes() # to get all the notes
>>> joplin.get_tags() # to get all the tags

Tests

before starting the Unit Test, you will need to set the Token line 9 of test.py

token = 'the token found on the webclipper config of joplin desktop'