Type-safe python SDK for HackMD developer
Project description
HackMD Python SDK
It is a Type-safe Python SDK that can let your HackMD development fastly.
Usage
pip install hackmd
# or
python setup.py install
from hackmd.client import Hackmd
hack = Hackmd(token="YOUR_TOKEN")
me = hack.get_me()
print(me.teams[0].name) # Your team name
print(me.name) # Your HackMD name
Methods
Authentication: X-HackMD-API-Version: 1.0.0
User
- get_me()
- return: Me()
User Note
- get_notes()
- return: List[Notes]
- get_note(note_id=note_id)
- return: Note()
- create_note(body=NoteCreate)
- return: Note()
- update_note(note_id=note_id, body=NoteUpdate)
- return: Note()
- delete_note(note_id=note_id)
- return: ''
- get_read_notes_history()
- return: List[Notes]
Development
git clone
cd hackmd-sdk-python/
pythom -m pytest tests/
License
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
Built Distribution
Close
Hashes for hackmd_sdk_python-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7931a4e72e940a549e6070a9ff11d20ba3590fb73baceb0d5ac0283a21f5787f |
|
MD5 | de7682c7b8494ac938bfa6006c34f254 |
|
BLAKE2b-256 | c9182a694dad6498f1a4ec866585a6771fce3c576a8e0cfc3d83eded72673042 |