Skip to content

Docs/improve readme #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
BonfaceKilz wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Docs/improve readme #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a8545c8
docs: Reword some sections
BonfaceKilz Oct 5, 2022
51935f0
Delete noisy "print" statement
BonfaceKilz Oct 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 13 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,24 @@ Python Pesa SDK

## Installation

This package is available in [Python Package Index](https://pypi.org/project/pyppesa/) and can be installed using `pip`
This package is available in [Python Package Index](https://pypi.org/project/pyppesa/) and can be installed using `pip`:

```
pip install pypesa
```

The package comprise both original open API codes and refactored codes.
This package comprises interfaces for interacting with:

To use original open API code import `open_api` module
- M-PESA/Vodafone vis-a-vis a generic open API that can be used with [Daraja](https://developer.safaricom.co.ke/Documentation); and
- Vodafone vis-a-vis the [Vodacom Open API portal](https://openapiportal.m-pesa.com/login).

To use the generic API interface:

```
from pypesa.open_api import APIContext, APIMethodType, APIRequest
```

To use refactored code import `MPESA` from `vodacom` module.
To use the `vodacom` module:

```
from pypesa.vodacom import MPESA
Expand All @@ -35,12 +38,12 @@ from pypesa.vodacom import MPESA

## Pre-requisites

The following are required and are obtained from [Vodacom Open Api portal](https://openapiportal.m-pesa.com/login)
The following are required and are obtained from [Vodacom Open Api portal](https://openapiportal.m-pesa.com/login):

- Api Key
- API Key
- Public Key

See more in [documentation](https://pypesa.readthedocs.io/en/latest/).
Read more [here](https://pypesa.readthedocs.io/en/latest/).

## Examples

Expand All @@ -50,10 +53,6 @@ See more in [documentation](https://pypesa.readthedocs.io/en/latest/).
# vodacom M-PESA
from pypesa.vodacom import MPESA

api_key = '<your-api-key>'
public_key = '<open-api-public-key>'

m_pesa = MPESA(api_key=api_key, public_key=public_key)

# Customer to Business payment
parameters = {
Expand All @@ -67,10 +66,12 @@ parameters = {
'input_PurchasedItemsDesc': 'Shoes',
}

m_pesa = MPESA(api_key='<your-api-key>',
public_key='<open-api-public-key>')
response = m_pesa.customer2business(parameters)
```

Check more examples of methods and responses in [docs](https://pypesa.readthedocs.io/en/latest/examples/)
Check out more examples of methods and responses [here](https://pypesa.readthedocs.io/en/latest/examples/).

## Credits

Expand Down
1 change: 0 additions & 1 deletion pypesa/open_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@ def __post(self):
r = requests.post(self.context.get_url(),
headers=self.context.get_headers(),
json=self.context.get_parameters())
print(r)
return APIResponse(r.status_code,
json.loads(r.headers.__str__().replace("'", '"')),
json.loads(r.text))
Expand Down