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
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file hackmd-sdk-python-0.1.1.tar.gz.
File metadata
- Download URL: hackmd-sdk-python-0.1.1.tar.gz
- Upload date:
- Size: 4.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8379c86e01d44317ea6e4ab00e6b73347c590b5bcdf0c6d5f41c6b2a36550cdf
|
|
| MD5 |
f2ee92c0120ec23d0c900150a8a429b9
|
|
| BLAKE2b-256 |
25164c7e9e119e42903c8f289839bd95f76cc103855fb2f4dff2fa6a411fddd1
|
File details
Details for the file hackmd_sdk_python-0.1.1-py3-none-any.whl.
File metadata
- Download URL: hackmd_sdk_python-0.1.1-py3-none-any.whl
- Upload date:
- Size: 4.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6f9f82cd61e36da59cf661ae9f664e5a97d020c70ff3ba9804aabf0b9478c751
|
|
| MD5 |
9366dc914e98ff706840a403abf1f27d
|
|
| BLAKE2b-256 |
6d483d567fd6aad0a36f7e7ca7c74fcdef7698953755e163b40a243d8c8badd6
|
