Version 2.0.0 (#81)

.env.example

@@ -0,0 +1,5 @@
+export CLIENT_ID=<client_id>
+export PUBLIC_KEY=<public_key>
+export SECRET=<secret>
+
+"$@"

.gitignore

@@ -1,40 +1,16 @@
-*.py[cod]
+.env
 
-# C extensions
-*.so
+*.pyc
+__pycache__
 
-# Packages
 *.egg
 *.egg-info
-dist
-build
-eggs
-parts
-bin
-var
-sdist
-develop-eggs
-.installed.cfg
-lib
-lib64
-__pycache__
 
-# Installer logs
-pip-log.txt
+venv
 
-# Unit test / coverage reports
+.cache/*
 .coverage
-.tox
-.cache
-nosetests.xml
-
-# Translations
-*.mo
-
-# Mr Developer
-.mr.developer.cfg
-.project
-.pydevproject
+.tox/*
 
-#pycharm
-.idea
+docs/.*
+docs/objects.inv

CONTRIBUTING.md

@@ -0,0 +1,36 @@
+# Contributing
+
+## Setup
+
+1. From the `plaid-node-apiv2` directory, create the `.env` file, which will be used to configure the Plaid client.
+
+  ```
+  cp .env.example .env
+  ```
+
+2. Go to the [Plaid Dashboard](https://dashboard.plaid.com/) and copy and paste your `client_id`, `public_key`, and `secret`
+   into `.env` using a text editor of your choice. Your account must be enabled for sandbox access.
+
+3. Install the necessary dependencies.
+
+  ```
+  make setup
+  ```
+
+## Running Tests
+
+Please lint (with `flake8`) and test your pull requests:
+
+```console
+$ make lint
+$ ./.env make test
+```
+
+## Updating Documentation
+
+The generated HTML documentation is served directly from the `master` branch
+of the repository. To update the generated documentation:
+
+```console
+$ make docs
+```

Makefile

@@ -11,3 +11,9 @@ test: lint
 .PHONY: setup
 setup:
 	pip install -r requirements.txt
+
+
+.PHONY: docs
+docs:
+	-rm -r docs/
+	sphinx-build docs_source/ docs/ -b html