# django_paystack
[![PyPI version](https://badge.fury.io/py/django_paystack.svg)](https://badge.fury.io/py/django_paystack)
[![Build Status](https://travis-ci.org/kingnonso/django_paystack.svg?branch=master)](https://travis-ci.org/kingnonso/django_paystack)
[![codecov](https://codecov.io/gh/kingnonso/django_paystack/branch/master/graph/badge.svg)](https://codecov.io/gh/kingnonso/django_paystack)
Django Paystack Payments package
## Documentation
The full documentation is at [https://django_paystack.readthedocs.io](https://django_paystack.readthedocs.io).
## Quickstart
Install django_paystack:
```bash
pip install django_paystack
```
Add it to your `INSTALLED_APPS`:
```python
INSTALLED_APPS = (
...
'django_paystack',
...
)
```
Then in your settings.py file, create the following settings:
```python
PAYSTACK_SETTINGS = {
"PUBLIC_KEY": "pk_test_xxx",
"SECRET_KEY": "sk_test_xxx",
"CURRENCY": "NGN",
"BUTTON_CLASS": "",
"BUTTON_ID": "django-paystack-button",
"SUCCESS_URL": "paystack:success_page",
"FAILURE_URL": "paystack:failure_page",
}
```
Add django_paystack's URL patterns:
```python
urlpatterns = [
...
path("paystack/", include(('django_paystack.urls','paystack'),namespace='paystack')),
...
]
```
## Features
- TODO
## Running Tests
Does the code actually work?
```bash
source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox
```
## Development commands
```bash
pip install -r requirements_dev.txt
invoke -l
```
## Credits
Tools used in rendering this package:
- Based on the work of [pypaystack2](https://gray-adeyi.github.io/pypaystack2/)
- Inspiration from [gbozee/pypaystack](https://github.com/gbozee/pypaystack)
Raw data
{
"_id": null,
"home_page": "https://github.com/kingnonso/django_paystack",
"name": "django-paystack",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "django_paystack",
"author": "Chinonso Ani",
"author_email": "achinonso@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/6f/d1/b0f56d5e1dace2c12efe9fbb9365d0a2010bce270ed33249b8ee184292ee/django_paystack-1.0.0.tar.gz",
"platform": null,
"description": "# django_paystack\n\n[![PyPI version](https://badge.fury.io/py/django_paystack.svg)](https://badge.fury.io/py/django_paystack)\n[![Build Status](https://travis-ci.org/kingnonso/django_paystack.svg?branch=master)](https://travis-ci.org/kingnonso/django_paystack)\n[![codecov](https://codecov.io/gh/kingnonso/django_paystack/branch/master/graph/badge.svg)](https://codecov.io/gh/kingnonso/django_paystack)\n\nDjango Paystack Payments package\n\n## Documentation\n\nThe full documentation is at [https://django_paystack.readthedocs.io](https://django_paystack.readthedocs.io).\n\n## Quickstart\n\nInstall django_paystack:\n\n```bash\npip install django_paystack\n```\n\nAdd it to your `INSTALLED_APPS`:\n\n```python\nINSTALLED_APPS = (\n ...\n 'django_paystack',\n ...\n)\n```\n\nThen in your settings.py file, create the following settings:\n```python\n\nPAYSTACK_SETTINGS = {\n \"PUBLIC_KEY\": \"pk_test_xxx\",\n \"SECRET_KEY\": \"sk_test_xxx\",\n \"CURRENCY\": \"NGN\",\n \"BUTTON_CLASS\": \"\",\n \"BUTTON_ID\": \"django-paystack-button\",\n \"SUCCESS_URL\": \"paystack:success_page\",\n \"FAILURE_URL\": \"paystack:failure_page\",\n}\n\n```\n\nAdd django_paystack's URL patterns:\n\n```python\n\nurlpatterns = [\n ...\n path(\"paystack/\", include(('django_paystack.urls','paystack'),namespace='paystack')),\n ...\n]\n```\n\n## Features\n\n- TODO\n\n## Running Tests\n\nDoes the code actually work?\n\n```bash\nsource <YOURVIRTUALENV>/bin/activate\n(myenv) $ pip install tox\n(myenv) $ tox\n```\n\n## Development commands\n\n```bash\npip install -r requirements_dev.txt\ninvoke -l\n```\n\n## Credits\n\nTools used in rendering this package:\n\n- Based on the work of [pypaystack2](https://gray-adeyi.github.io/pypaystack2/)\n- Inspiration from [gbozee/pypaystack](https://github.com/gbozee/pypaystack)\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Django Paystack Payments package",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/kingnonso/django_paystack"
},
"split_keywords": [
"django_paystack"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cc7bc68884a61b60e7d48fe55ee21e62205b0b592911ff2ac078dbbe2bdc1360",
"md5": "882620d19d81e4a2459f95fbd0ad8b65",
"sha256": "bc3b67a5a11e38650f4c32a9a9816a2314c460f3e6a436214274ea8319880fd8"
},
"downloads": -1,
"filename": "django_paystack-1.0.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "882620d19d81e4a2459f95fbd0ad8b65",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.9",
"size": 9280,
"upload_time": "2024-04-17T17:26:11",
"upload_time_iso_8601": "2024-04-17T17:26:11.647726Z",
"url": "https://files.pythonhosted.org/packages/cc/7b/c68884a61b60e7d48fe55ee21e62205b0b592911ff2ac078dbbe2bdc1360/django_paystack-1.0.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6fd1b0f56d5e1dace2c12efe9fbb9365d0a2010bce270ed33249b8ee184292ee",
"md5": "4eb9d1b55d0cc2d1ecda1a88b8cd543f",
"sha256": "a142b78daff6ae53625dfe8f2445b59732ac924d5ff157af506ae049f76a284a"
},
"downloads": -1,
"filename": "django_paystack-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "4eb9d1b55d0cc2d1ecda1a88b8cd543f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 10262,
"upload_time": "2024-04-17T17:26:13",
"upload_time_iso_8601": "2024-04-17T17:26:13.573771Z",
"url": "https://files.pythonhosted.org/packages/6f/d1/b0f56d5e1dace2c12efe9fbb9365d0a2010bce270ed33249b8ee184292ee/django_paystack-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-17 17:26:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kingnonso",
"github_project": "django_paystack",
"github_not_found": true,
"lcname": "django-paystack"
}