REST_Demo_API

A demo API for use with an APIs/REST presentation.

Installation

• $ git clone https://github.com/bnbalsamo/rest_demo_api.git
• $ cd rest_demo_api
• (Optional) Make any required changes to requirements.txt
  • Note: Unpinning or changing dependency versions may effect functionality
• $ pip install -r requirements.txt
• $ python setup.py install

Development

Running Tests

$ pip install -r requirements/requirements_tests.txt
$ tox

Note: Tox will run tests against the version of the software installed via python setup.py install. To test against pinned dependencies add -r requirements.txt to the deps array of the tox.ini testenv section.

Updating Dependencies

• pip install -r requirements/requirements_dev.txt
• Review requirements/requirements_loose.txt
• tox -e pindeps
• cp .tox/requirements.txt .
• Copy pinned requirements into setup.py

Generate Local Docs

$ python generate_spec.py > spec.json
$ firefox docs_preview.html

Author

Brian Balsamo Brian@BrianBalsamo.com