Skip to content

Commit d8119af

Browse files
author
Aman Aalam
authored
Merge pull request #27 from trolley/dev
updated README instructions
2 parents 5a0fde1 + dc91232 commit d8119af

File tree

1 file changed

+20
-41
lines changed

1 file changed

+20
-41
lines changed

README.md

Lines changed: 20 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,28 @@
11
[![Latest Stable Version](https://img.shields.io/pypi/v/trolleyhq.svg)](https://pypi.python.org/pypi/trolleyhq)
22

3-
43
# Trolley Python SDK
54

6-
A native Python SDK for the Trolley API
5+
A native [Python](https://www.python.org/) SDK for the Trolley API
6+
7+
78

89
## Installation
910

10-
#
11+
Use pip to install the latest version of the package
12+
13+
```
14+
$ pip install trolleyhq
15+
```
1116

12-
#### For [Python](https://www.python.org/)
1317

14-
#
15-
#### To install the reference:
1618

17-
## Dependencies
19+
#### Dependencies
1820

1921
* Python
2022
* [requests](http://docs.python-requests.org/en/latest/)
2123
* [Mock](https://pypi.org/project/mock/) - For unit tests
2224

23-
## Running Tests
2425

25-
```
26-
// unit tests
27-
$ python -m unittest test/unit/testBalances.py
28-
29-
//integration tests
30-
$ python test/integration/RecipientTest.py
31-
```
3226

3327
## Getting Started
3428

@@ -37,42 +31,27 @@ from trolley.configuration import Configuration
3731
from trolley.recipients import Recipients
3832

3933
client = Configuration.gateway("ACCESS_KEY","SECRET_KEY")
40-
response = client.recipient.find("R-WJniNq7PUXyboAJetimmJ4")
34+
response = client.recipient.find("R-WJniNq7PUAJetimmJ4")
4135

4236
print(response.id)
4337
```
4438

45-
## Documentation for API Endpoints
46-
47-
All URIs are available at https://docs.trolley.com/
48-
49-
All URIs are relative to *https://api.trolley.com/v1*
50-
51-
### Usage
52-
53-
Methods should all have Python Doc comments to help you understand their usage. As mentioned the [full API documentation](https://docs.trolley.com)
54-
is the best source of information about the API.
55-
56-
For more information please read the our docs at [https://docs.trolley.com](https://docs.trolley.com).
57-
The [Python API docs](https://github.com/PaymentRails/python-sdk/tree/master/docs/) can be found in this repo. The best starting point is:
58-
59-
| Data Type | SDK Documentation |
60-
| ----- | ----- |
61-
| Batch | [API Docs for Batch](https://github.com/PaymentRails/python-sdk/tree/master/docs/classes/batchgateway.md) |
62-
| Payment | [API Docs for Payment](https://github.com/PaymentRails/python-sdk/tree/master/docs/classes/paymentgateway.md) |
63-
| Recipient | [API Docs for Recipient](https://github.com/PaymentRails/python-sdk/tree/master/docs/classes/recipientgateway.md) |
64-
| Recipient Account | [API Docs for Recipient Account](https://github.com/PaymentRails/python-sdk/tree/master/docs/classes/recipientaccountgateway.md) |
6539

6640

41+
## Running Tests
6742

43+
```
44+
// unit tests
45+
$ python -m unittest test/unit/testBalances.py
6846
47+
//integration tests
48+
$ python test/integration/RecipientTest.py
49+
```
6950

7051

7152

72-
## Documentation for Authorization
53+
## Documentation
7354

74-
### merchantKey
55+
Documentation about how to use our Python SDK is available at https://docs.trolley.com/
7556

76-
- **Type**: Authorization
77-
- **Authorization parts**: public key, secret key
78-
- **Location**: HTTP header
57+
Besides that, methods should all have Python Doc comments to help you understand their usage.

0 commit comments

Comments
 (0)