A Python interface for HackMD API
Project description
Table of Contents
What's this
python-HackMD
is a Python interface for HackMD API. Read the full docs on ReadTheDocs.
Getting Started
Prerequisites
- Python 3.6+
- HackMD API token (How to create a token)
Installation
pip install python-HackMD
Basic Usage
Let's create an API object before everything starts.
from PyHackMD import API
api = API('<token>')
User API
- Get user information
data = api.get_me()
print(data)
User Notes API
- Get a list of notes in the user's workspace
data = api.get_notes()
print(data)
- Get a note
# note_id can be obtained using get_notes()
data = api.get_note('<note_id>')
print(data)
- Create a note
data = api.create_note(
title='New Note',
content='blablabla',
read_perm='signed_in',
write_perm='owner',
comment_perm='signed_in_users')
print(data)
- Update a note
# note_id can be obtained using get_notes()
data = api.update_note(
'<note_id>',
content='blablabla',
read_perm='signed_in',
write_perm='owner',
comment_perm='signed_in_users')
print(data)
- Delete a note
# note_id can be obtained using get_notes()
data = api.delete_note('<note_id>')
print(data)
- Get a history of read notes
data = api.get_read_history()
print(data)
Teams API
- Get a list of the teams to which the user has permission
data = api.get_teams()
print(data)
Team Notes API
- Get a list of notes in a Team's workspace
# team_path can be obtained using get_teams()
data = api.get_team_notes('<team_path>')
print(data)
- Get a note in a Team's workspace
# note_id can be obtained using get_team_notes()
data = api.get_team_note('<note_id>')
print(data)
- Create a note in a Team workspace
# team_path can be obtained using get_teams()
data = api.create_team_note(
'<team_path>'
title='New Note',
content='blablabla',
read_perm='signed_in',
write_perm='owner',
comment_perm='signed_in_users')
print(data)
- Update a note in a Team's workspace
# team_path can be obtained using get_teams()
# note_id can be obtained using get_team_notes()
data = api.update_team_note(
'<team_path>', '<note_id>',
content='blablabla',
read_perm='signed_in',
write_perm='owner',
comment_perm='signed_in_users')
print(data)
- Delete a note in a Team's workspace
# team_path can be obtained using get_teams()
# note_id can be obtained using get_team_notes()
data = api.delete_team_note('<team_path>', '<note_id>')
print(data)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
python-HackMD-1.0.3.tar.gz
(3.1 kB
view hashes)
Built Distribution
Close
Hashes for python_HackMD-1.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | aa00ca0186d39e0db875b4d3e93dac23e963c0f3dc7e978efd8c4aa3a518fe14 |
|
MD5 | b2ceab12c6d275f11828715929a1c304 |
|
BLAKE2b-256 | 7afeca2c70c65cbc0a4ca42d1cc5c72cfaf359ffe15a9edf71446419ac336ec0 |