Metadata-Version: 2.1
Name: PyHackMD
Version: 1.0.2
Summary: Python
Home-page: https://github.com/GoatWang/PyHackMD
Author: GoatWang
Author-email: jeremy4555@yahoo.com.tw
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: requests

# Introduction
This is the python interface of [HackMD API](https://hackmd.io/@hackmd-api/developer-portal/).

# Getting Start
## prerequists
1. Python (version free)
2. HackMD Token: please see [official website](https://hackmd.io/@hackmd-api/developer-portal/https%3A%2F%2Fhackmd.io%2F%40hackmd-api%2Fhow-to-issue-an-api-token) to get the token.

## Installation
```
pip install PyHackMD
```

## API Interface
1. Get Note list
```python
from PyHackMD import API
from pprint import pprint
api = API('<token>')
data = api.get_note_list()
pprint(data)
```

2. Get Note Content
```python
from PyHackMD import API
from pprint import pprint
api = API('<token>')
data = api.get_note('<note_id>')
pprint(data)
```

3. Create Note
```python
from PyHackMD import API
from pprint import pprint
api = API('<token>')
data = api.create_note(title="Test Create Note")
pprint(data)
```

4. Update Note
```python
from PyHackMD import API
from pprint import pprint
api = API('<token>')
data = api.update_note("<note_id>", content="# Test Update Note")
pprint(data)
```

5. Delete Note
```python
from PyHackMD import API
from pprint import pprint
api = API('<token>')
data = api.delete_note("<note_id>")
pprint(data)
```

6. Get Note Read History
```python
from PyHackMD import API
from pprint import pprint
api = API('<token>')
data = api.get_note_read_history()
pprint(data)
```

# Build & Upload
1. change version in setup.py

2. Build wheel
```
python setup.py bdist_wheel
```

3. Upload to pypi 
```
twine upload dist/*
```

# Version Note
## 1.0.2
1. add Introduction in README.md

## 1.0.1
1. add url in setup.py
2. add installation method in README.md

## 1.0.0
First Release

