Skip to content

Commit 99777b0

Browse files
author
Tarric Sookdeo
committed
Update README to contain section about Docker
1 parent 38631f3 commit 99777b0

File tree

1 file changed

+27
-21
lines changed

1 file changed

+27
-21
lines changed

README.md

Lines changed: 27 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This repository contains the source code for Dwolla's Python-based SDK, which allows developers to interact with Dwolla's server-side API via a Python API. Any action that can be performed via an HTTP request can be made using this SDK when executed within a server-side environment.
44

5-
## Table of Contents
5+
## Table of Contents
66

77
- [Getting Started](#getting-started)
88
- [Installation](#installation)
@@ -18,7 +18,6 @@ This repository contains the source code for Dwolla's Python-based SDK, which al
1818
- [Community](#community)
1919
- [Additional Resources](#additional-resources)
2020

21-
2221
## Getting Started
2322

2423
### Installation
@@ -33,8 +32,8 @@ $ pip install dwollav2
3332

3433
Before any API requests can be made, you must first determine which environment you will be using, as well as fetch the application key and secret. To fetch your application key and secret, please visit one of the following links:
3534

36-
* Production: https://dashboard.dwolla.com/applications
37-
* Sandbox: https://dashboard-sandbox.dwolla.com/applications
35+
- Production: https://dashboard.dwolla.com/applications
36+
- Sandbox: https://dashboard-sandbox.dwolla.com/applications
3837

3938
Finally, you can create an instance of `Client` with `key` and `secret` replaced with the application key and secret that you fetched from one of the aforementioned links, respectively.
4039

@@ -68,7 +67,6 @@ It is highly recommended that you encrypt any token data you store.
6867

6968
Application access tokens are used to authenticate against the API on behalf of an application. Application tokens can be used to access resources in the API that either belong to the application itself (`webhooks`, `events`, `webhook-subscriptions`) or the Dwolla Account that owns the application (`accounts`, `customers`, `funding-sources`, etc.). Application tokens are obtained by using the [`client_credentials`](https://tools.ietf.org/html/rfc6749#section-4.4) OAuth grant type:
7069

71-
7270
```python
7371
application_token = client.Auth.client()
7472
```
@@ -93,6 +91,7 @@ Once you've created a `Token`, currently, you can make low-level HTTP requests.
9391
To make low-level HTTP requests, you can use the `get()`, `post()`, and `delete()` methods. These methods will return a `Response` object.
9492

9593
#### `GET`
94+
9695
```python
9796
# GET api.dwolla.com/resource?foo=bar
9897
token.get('resource', foo = 'bar')
@@ -103,6 +102,7 @@ token.get('resource', {'foo' = 'bar', 'baz' = 'foo'})
103102
```
104103

105104
#### `POST`
105+
106106
```python
107107
# POST api.dwolla.com/resource {"foo":"bar"}
108108
token.post('resource', foo = 'bar')
@@ -112,6 +112,7 @@ token.post('resource', foo = ('mclovin.jpg', open('mclovin.jpg', 'rb'), 'image/j
112112
```
113113

114114
#### `DELETE`
115+
115116
```python
116117
# DELETE api.dwolla.com/resource
117118
token.delete('resource')
@@ -134,8 +135,8 @@ The following snippets demonstrate successful and errored responses from the Dwo
134135

135136
An errored response is returned when Dwolla's servers respond with a status code that is greater than or equal to 400, whereas a successful response is when Dwolla's servers respond with a 200-level status code.
136137

137-
138138
##### Success
139+
139140
```python
140141
res = token.get('/')
141142

@@ -169,6 +170,7 @@ except dwollav2.NotFoundError as e:
169170
except dwollav2.Error:
170171
# ...
171172
```
173+
172174
###### `dwollav2.Error` subclasses:
173175

174176
_See https://developers.dwolla.com/api-reference#errors for more info._
@@ -236,25 +238,29 @@ _See https://developers.dwolla.com/api-reference#errors for more info._
236238
- **1.1.0** Support per-request headers
237239

238240
## Community
239-
* If you have any feedback, please reach out to us on [our forums](https://discuss.dwolla.com/) or by [creating a GitHub issue](https://github.com/Dwolla/dwolla-v2-python/issues/new).
240-
* If you would like to contribute to this library, [bug reports](https://github.com/Dwolla/dwolla-v2-python/issues) and [pull requests](https://github.com/Dwolla/dwolla-v2-python/pulls) are always appreciated!
241-
* After checking out the repo, run `pip install -r requirements.txt` to install dependencies. Then, run `python setup.py` test to run the tests.
242-
* To install this gem onto your local machine, `run pip install -e .`.
243-
241+
242+
- If you have any feedback, please reach out to us on [our forums](https://discuss.dwolla.com/) or by [creating a GitHub issue](https://github.com/Dwolla/dwolla-v2-python/issues/new).
243+
- If you would like to contribute to this library, [bug reports](https://github.com/Dwolla/dwolla-v2-python/issues) and [pull requests](https://github.com/Dwolla/dwolla-v2-python/pulls) are always appreciated!
244+
- After checking out the repo, run `pip install -r requirements.txt` to install dependencies. Then, run `python setup.py` test to run the tests.
245+
- To install this gem onto your local machine, `run pip install -e .`.
246+
247+
## Docker
248+
249+
If you prefer to use Docker to run dwolla-v2-python locally, a Dockerfile is included at the root directory.
250+
Follow these instructions from [Docker's website](https://docs.docker.com/build/hellobuild/) to create a Docker image from the Dockerfile, and run it.
244251

245252
## Additional Resources
246253

247254
To learn more about Dwolla and how to integrate our product with your application, please consider visiting the following resources and becoming a member of our community!
248255

249-
* [Dwolla](https://www.dwolla.com/)
250-
* [Dwolla Developers](https://developers.dwolla.com/)
251-
* [SDKs and Tools](https://developers.dwolla.com/sdks-tools)
252-
* [Dwolla SDK for C#](https://github.com/Dwolla/dwolla-v2-csharp)
253-
* [Dwolla SDK for Kotlin](https://github.com/Dwolla/dwolla-v2-kotlin)
254-
* [Dwolla SDK for Node](https://github.com/Dwolla/dwolla-v2-node)
255-
* [Dwolla SDK for PHP](https://github.com/Dwolla/dwolla-swagger-php)
256-
* [Dwolla SDK for Ruby](https://github.com/Dwolla/dwolla-v2-ruby)
257-
* [Developer Support Forum](https://discuss.dwolla.com/)
258-
256+
- [Dwolla](https://www.dwolla.com/)
257+
- [Dwolla Developers](https://developers.dwolla.com/)
258+
- [SDKs and Tools](https://developers.dwolla.com/sdks-tools)
259+
- [Dwolla SDK for C#](https://github.com/Dwolla/dwolla-v2-csharp)
260+
- [Dwolla SDK for Kotlin](https://github.com/Dwolla/dwolla-v2-kotlin)
261+
- [Dwolla SDK for Node](https://github.com/Dwolla/dwolla-v2-node)
262+
- [Dwolla SDK for PHP](https://github.com/Dwolla/dwolla-swagger-php)
263+
- [Dwolla SDK for Ruby](https://github.com/Dwolla/dwolla-v2-ruby)
264+
- [Developer Support Forum](https://discuss.dwolla.com/)
259265

260266
[`idempotency-key`]: https://docs.dwolla.com/#idempotency-key

0 commit comments

Comments
 (0)