Merge pull request #3 from Paubox/add-dependencies

Add `requests` dependency to `setup.py`

.gitignore

@@ -9,6 +9,8 @@ tests/config.cfg
 
 # Setuptools distribution folder.
 /dist/
+# Distribution
+build/
 
 # Python egg metadata, regenerated from source files by setuptools.
 # paubox_python.egg-info

CHANGELOG.md

@@ -5,4 +5,8 @@ All notable changes to this project will be documented in this file.
 ### 🚀 Major Release
 This is the first release of the official Paubox-python3 package. This package is not intended to be backwards compatible with Python2, and users who are using Python2 should navigate to our Python2 [paubox-python](https://github.com/Paubox/paubox-python) package.
 
-- [#1](https://github.com/Paubox/paubox-python3/pull/1) Build a working version of the Paubox-python3 SDK. ([@niwong](https://github.com/niwong))
+- [#1](https://github.com/Paubox/paubox-python3/pull/1) Build a working version of the Paubox-python3 SDK. ([@niwong](https://github.com/niwong))
+
+# v1.0.1 / 2021-06-09
+### 🎉 Enhancements
+- [#3](https://github.com/Paubox/paubox-python3/pull/3) Add `requests` dependency to `setup.py`. ([@niwong](https://github.com/niwong))

README.md

@@ -4,7 +4,7 @@
 
 This is the official **Python3** package for the Paubox Email API. 
 
-The Paubox Email API allows your application to send secure, HIPAA compliant email via Paubox and track deliveries and opens.
+The Paubox Email API allows your application to send secure, HIPAA compliant email via [Paubox](https://www.paubox.com) and track email deliveries and opens.
 
 # Table of Contents
 *  [Installation](#installation)
@@ -23,18 +23,18 @@ The Paubox Email API allows your application to send secure, HIPAA compliant ema
 ### Getting Paubox API Credentials
 You will need to have a Paubox account. You can [sign up here](https://www.paubox.com/pricing#paubox-email-api).
 
-Once you have an account, follow the instructions on the REST API dashboard to verify domain ownership and generate API credentials. Further **[quickstart instructions for this process can be found here.](https://docs.paubox.com/docs/paubox_email_api/quickstart)**
+Once you have an account, follow the instructions on the REST API dashboard to verify domain ownership and generate API keys. Further **[quickstart instructions for this process can be found here.](https://docs.paubox.com/docs/paubox_email_api/quickstart)**
 
 ### Configuring API Credentials Locally
 
-Include your API credentials in a config file (e.g. `config.cfg`)
+While you can simply hard-code your authentication credentials, it's often better practice to tuck these values away in an environment or configuration file. Our following code snippets leverage the use of the [`config`](https://docs.red-dove.com/cfg/python.html#python-getting-started) python package to load our credentials. To set `config` up, include your API key credentials in a config file (e.g. `config.cfg`)
 
 ```
 PAUBOX_HOST: 'https://api.paubox.net/v1/YOUR_ENDPOINT_NAME'
 PAUBOX_API_KEY: 'YOUR_API_KEY'
 ```
 
-Please install config package using pip3 to load API credentials from the
+Then, install the `config` package using pip3 to load API credentials from the
 `config.cfg` file:
 
 ```
@@ -340,7 +340,7 @@ print(disposition_response.text)
 ```
 <a name="#contributing"></a>
 ## Contributing
-The Paubox-python3 SDK is maintained by Paubox, Inc.
+The Paubox-python3 SDK is maintained by [Paubox, Inc.](https://www.paubox.com)
 
 We want to empower our users building applications with the Paubox Email API, and so we encourage you to file bug reports/create GitHub issues and pull requests. Chances are other developers using our Email API might be having similar ideas about new features or approaches to improving the SDK, so we encourage you to upvote or comment on existing issues or pull requests! 
 

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="paubox-python3",
-    version="1.0.0",
+    version="1.0.1",
     author="Paubox",
     author_email="[email protected]",
     description="Python3 SDK for Paubox Email REST API",
@@ -17,4 +17,7 @@
         "Programming Language :: Python :: 3.8",
         "License :: OSI Approved :: Apache Software License"
     ],
+    install_requires=[
+        'requests',
+    ]
 )