Skip to content

Commit

Permalink
Prepare for releasing to PyPI
Browse files Browse the repository at this point in the history
  • Loading branch information
luke8086 committed Jan 24, 2020
1 parent b5e4e11 commit 536098a
Show file tree
Hide file tree
Showing 6 changed files with 39 additions and 10 deletions.
6 changes: 5 additions & 1 deletion .gitignore
@@ -1,2 +1,6 @@
/__pycache__
__pycache__

/.vscode
/build
/dist
/paywhirl.egg-info/
File renamed without changes.
18 changes: 9 additions & 9 deletions README.md
Expand Up @@ -7,11 +7,10 @@ The [Documentation] linked here and below contains all of the available methods
for interacting with your PayWhirl account. If you would like to see additional
functionality added, feel free to submit an issue or a pull request.



[PayWhirl]: https://app.paywhirl.com/
[Python]: https://www.python.org/
[Documentation]: https://api.paywhirl.com/

### Usage Guide

- [Documentation]
Expand All @@ -20,6 +19,7 @@ functionality added, feel free to submit an issue or a pull request.

- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [License](#license)
- [About](#about)

Expand All @@ -29,14 +29,16 @@ functionality added, feel free to submit an issue or a pull request.

## Installation

Place the `.py` file in your project and import the class so that you can
instantiate a PayWhirl object.
```bash
$ pip3 install --upgrade paywhirl
```

When you create a new PayWhirl object you need to pass in your API key and
## Usage

To create a new PayWhirl object, you need to pass your API key and
secret, which can be found in the [API key section of the main site](https://app.paywhirl.com/api-keys).

```python
# include PayWhirl Python SDK
from paywhirl import PayWhirl, HTTPError

api_key = 'pwpk_xxxxxxxxxxxxxxx'
Expand All @@ -51,14 +53,12 @@ except HTTPError as e:
print(e.response.text)
```



## License

PayWhirl is copyright © 2016-2018 [PayWhirl Inc.][PayWhirl] This library is free
software, and may be redistributed under the terms specified in the [license].

[license]: LICENSE.md
[license]: LICENSE

## About

Expand Down
3 changes: 3 additions & 0 deletions paywhirl/__init__.py
@@ -0,0 +1,3 @@
from .paywhirl import PayWhirl, HTTPError

__all__ = ['PayWhirl', 'HTTPError']
File renamed without changes.
22 changes: 22 additions & 0 deletions setup.py
@@ -0,0 +1,22 @@
import setuptools

with open("README.md", "r") as fh:
long_description = fh.read()

setuptools.setup(
name="paywhirl",
version="1.2",
author="PayWhirl",
author_email="developer@paywhirl.com",
description="Python client for PayWhirl API",
long_description=long_description,
long_description_content_type="text/markdown",
url="https://github.com/paywhirl/python-pwclient",
packages=setuptools.find_packages(),
classifiers=[
"Programming Language :: Python :: 3",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
],
python_requires='>=3.5',
)

0 comments on commit 536098a

Please sign in to comment.