# paystack-python
[](https://coveralls.io/github/andela-sjames/paystack-python?branch=master)
[](https://scrutinizer-ci.com/g/andela-sjames/paystack-python/?branch=master)
[](https://img.shields.io/badge/license-MIT-blue.svg) [](https://travis-ci.org/andela-sjames/paystack-python)
[](https://badge.fury.io/py/paystackapi)
Python plugin for [Paystack](https://paystack.com/)
View on [pypi.python.org](https://pypi.python.org/pypi/paystackapi)
## Installation
```shell
pip install paystackapi
```
## Instantiate Paystack
```python
from paystackapi.paystack import Paystack
paystack_secret_key = "5om3secretK3y"
paystack = Paystack(secret_key=paystack_secret_key)
# to use transaction class
paystack.transaction.list()
# to use customer class
paystack.customer.get(transaction_id)
# to use plan class
paystack.plan.get(plan_id)
# to use subscription class
paystack.subscription.list()
```
## DOC Reference: <https://developers.paystack.co/v2.0/reference>
### API Reference: [API](https://paystack.com/docs/api/)
### Other methods can be found in the docs folder
### Static Use
To start using the Paystack Python API, you need to start by setting your secret key.
You can set your secret key in your environment by running:
```bash
export PAYSTACK_SECRET_KEY = 'your_secret_key'
```
> Don't forget to get your API key from [Paystack](https://paystack.com/) and assign to the variable `PAYSTACK_SECRET_KEY`
### Available resources
```Python
BulkCharge
Charge
ControlPanel
Customer
Invoice
Misc
Page
Plan
Product
Refund
Settlement
SubAccount
Subscription
Transaction
TransferControl
Transfer
TransferSplit
TransferRecipient
Verification
```
Please reference the **[docs](https://github.com/andela-sjames/paystack-python/tree/master/docs)** folder for usage,
Raw data
{
"_id": null,
"home_page": "https://github.com/andela-sjames/paystack-python",
"name": "paystackapi",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "paystack python library",
"author": "Samuel James and Issa Jubril",
"author_email": "samuelvarejames@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/83/8a/eca58d74c30254cb27fa5ebf29bbf6a43bae8fd268bedabfaa0472d7dd30/paystackapi-2.1.3.tar.gz",
"platform": null,
"description": "# paystack-python\n\n[](https://coveralls.io/github/andela-sjames/paystack-python?branch=master)\n[](https://scrutinizer-ci.com/g/andela-sjames/paystack-python/?branch=master)\n[](https://img.shields.io/badge/license-MIT-blue.svg) [](https://travis-ci.org/andela-sjames/paystack-python)\n[](https://badge.fury.io/py/paystackapi)\n\nPython plugin for [Paystack](https://paystack.com/)\nView on [pypi.python.org](https://pypi.python.org/pypi/paystackapi)\n\n## Installation\n\n```shell\npip install paystackapi\n```\n\n## Instantiate Paystack\n\n```python\nfrom paystackapi.paystack import Paystack\npaystack_secret_key = \"5om3secretK3y\"\npaystack = Paystack(secret_key=paystack_secret_key)\n\n# to use transaction class\npaystack.transaction.list()\n\n# to use customer class\npaystack.customer.get(transaction_id)\n\n# to use plan class\npaystack.plan.get(plan_id)\n\n# to use subscription class\npaystack.subscription.list()\n```\n\n## DOC Reference: <https://developers.paystack.co/v2.0/reference>\n\n### API Reference: [API](https://paystack.com/docs/api/)\n\n### Other methods can be found in the docs folder\n\n### Static Use\n\nTo start using the Paystack Python API, you need to start by setting your secret key.\n\nYou can set your secret key in your environment by running:\n\n```bash\nexport PAYSTACK_SECRET_KEY = 'your_secret_key'\n```\n\n> Don't forget to get your API key from [Paystack](https://paystack.com/) and assign to the variable `PAYSTACK_SECRET_KEY`\n\n### Available resources\n\n```Python\n\nBulkCharge\nCharge\nControlPanel\nCustomer\nInvoice\nMisc\nPage\nPlan\nProduct\nRefund\nSettlement\nSubAccount\nSubscription\nTransaction\nTransferControl\nTransfer\nTransferSplit\nTransferRecipient\nVerification\n\n```\n\nPlease reference the **[docs](https://github.com/andela-sjames/paystack-python/tree/master/docs)** folder for usage,\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A python library to consume Paystack API",
"version": "2.1.3",
"project_urls": {
"Homepage": "https://github.com/andela-sjames/paystack-python"
},
"split_keywords": [
"paystack",
"python",
"library"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "838aeca58d74c30254cb27fa5ebf29bbf6a43bae8fd268bedabfaa0472d7dd30",
"md5": "db3145f2edd7ad7107fc5d3a573c3b27",
"sha256": "8035fa35e08ba32df4843b833992e737be0d993cce5ee09aee90c9f0ad40dc10"
},
"downloads": -1,
"filename": "paystackapi-2.1.3.tar.gz",
"has_sig": false,
"md5_digest": "db3145f2edd7ad7107fc5d3a573c3b27",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 18281,
"upload_time": "2024-08-07T23:11:07",
"upload_time_iso_8601": "2024-08-07T23:11:07.209131Z",
"url": "https://files.pythonhosted.org/packages/83/8a/eca58d74c30254cb27fa5ebf29bbf6a43bae8fd268bedabfaa0472d7dd30/paystackapi-2.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-07 23:11:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "andela-sjames",
"github_project": "paystack-python",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "paystackapi"
}
JSON
