Introduction
This is the python interface of HackMD API.
Getting Start
prerequists
- Python (version free)
- HackMD Token: please see official website to get the token.
Installation
pip install PyHackMD
API Interface
- Get Note list
from PyHackMD import API
from pprint import pprint
api = API('<token>')
data = api.get_note_list()
pprint(data)- Get Note Content
from PyHackMD import API
from pprint import pprint
api = API('<token>')
data = api.get_note('<note_id>')
pprint(data)- Create Note
from PyHackMD import API
from pprint import pprint
api = API('<token>')
data = api.create_note(title="Test Create Note")
pprint(data)- Update Note
from PyHackMD import API
from pprint import pprint
api = API('<token>')
data = api.update_note("<note_id>", content="# Test Update Note")
pprint(data)- Delete Note
from PyHackMD import API
from pprint import pprint
api = API('<token>')
data = api.delete_note("<note_id>")
pprint(data)- Get Note Read History
from PyHackMD import API
from pprint import pprint
api = API('<token>')
data = api.get_note_read_history()
pprint(data)Build & Upload
-
change version in setup.py
-
Build wheel
python setup.py bdist_wheel
- Upload to pypi
twine upload dist/PyHackMD-1.0.2-py3-none-any.whl
Version Note
1.0.2
- add Introduction in README.md
1.0.1
- add url in setup.py
- add installation method in README.md
1.0.0
First Release
