Skip to content

Commit 00f0c2d

Browse files
committed
Refactor README.rst to README.md with minimal examples
1 parent 9ef3db1 commit 00f0c2d

File tree

1 file changed

+65
-0
lines changed

1 file changed

+65
-0
lines changed

README.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
I'mport; REST Client
2+
--------------------
3+
4+
<div align="center">
5+
6+
[![Python Versions](https://img.shields.io/pypi/pyversions/iamport-rest-client)](https://pypi.org/project/iamport-rest-client/)
7+
[![PyPI Release (latest by date)](https://img.shields.io/pypi/v/iamport-rest-client?color=blue)](https://pypi.org/project/iamport-rest-client/)
8+
[![GitHub Workflow Status (Build)](https://img.shields.io/github/workflow/status/iamport/iamport-rest-client-python/Build%20Status)](https://github.com/iamport/iamport-rest-client-python/actions)
9+
[![GitHub LICENSE](https://img.shields.io/github/license/iamport/iamport-rest-client-python)](https://github.com/iamport/iamport-rest-client-python/blob/master/LICENSE)
10+
[![Lines of Code](https://img.shields.io/tokei/lines/github/iamport/iamport-rest-client-python)](https://github.com/iamport/iamport-rest-client-python/tree/master/iamport)
11+
12+
</div>
13+
14+
설명
15+
---
16+
> Python 개발자를 위한 [아임포트 REST API](https://api.iamport.kr/) 연동 패키지입니다.
17+
18+
기능
19+
---
20+
1. 결제 정보 찾기
21+
2. 가격 확인
22+
3. 취소
23+
4. 비 인증 결제
24+
5. 정기 예약 결제
25+
6. 본인인증결과 조회 및 삭제
26+
27+
설치
28+
---
29+
> 아임포트를 설치하실 때 아나콘다를 이용한 아임포트 파이썬 가상환경 구성을 추천합니다.
30+
[선택 사항] 아나콘다 환경에서 작업하신다면, 우선 아래의 절차를 진행해주세요.
31+
```bash
32+
# 아임포트 패키지를 위한 새로운 파이썬 가상환경을 생성해주세요. 이 때, 파이썬 버전은 최소 3.6 이상을 선택해주세요.
33+
conda create --name iamport python=3.6
34+
35+
# 위에서 파이썬 가상환경이 정상적으로 설치되었다면, 해당 가상환경을 활성화해주세요.
36+
conda activate pymodi
37+
```
38+
39+
아래의 커맨드를 실행하여 최신버전의 아임포트를 설치해주세요.
40+
```bash
41+
python -m pip install iamport-rest-client --upgrade
42+
```
43+
44+
준비
45+
---
46+
아임포트 객체를 생성합니다.
47+
```python
48+
from iamport import Iamport
49+
50+
# 아임포트 객체를 테스트용 키와 시크릿을 사용하여 생성합니다 (테스트시 지출된 금액은 매일 밤 환불됩니다).
51+
iamport = Iamport(
52+
imp_key='imp_apikey',
53+
imp_secret=(
54+
'ekKoeW8RyKuT0zgaZsUtXXTLQ4AhPFW3ZGseDA6b'
55+
'kA5lamv9OqDMnxyeB9wqOsuO9W3Mx9YSJ4dTqJ3f'
56+
)
57+
)
58+
59+
# 아임포트 객체를 각자 발급받으신 실제 키와 시크릿을 사용하여 생성합니다.
60+
iamport = Iamport(imp_key='{발급받은 키}', imp_secret='{발급받은 시크릿}')
61+
```
62+
63+
기여하기
64+
------
65+
[iamport-rest-client-python 프로젝트 보드](https://github.com/iamport/iamport-rest-client-python/projects/1)`To do` 탭을 참고해주세요.

0 commit comments

Comments
 (0)