Giter Club home page Giter Club logo

rest_demo_api's Introduction

REST_Demo_API v0.0.1

Build Status Coverage Status Updates Code style: black

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 [email protected]

rest_demo_api's People

Contributors

bnbalsamo avatar

Watchers

avatar avatar

rest_demo_api's Issues

Dummy Data Bootstrapping Script

Write a script that will bootstrap a decent amount of data into the API once it's up and running to initially populate the API if required.

Pin marshmallow to <3

Marshmallow has a new version on the horizon with breaking API changes. Need to pin it in the requirements_loose.txt to be sure we don't accidentally upgrade and break a bunch of stuff.

Initial Update

The bot created this issue to inform you that pyup.io has been set up on this repo.
Once you have closed it, the bot will open pull requests for updates as soon as they are available.

Envelope results

Envelope results via either a method like this or by specifying a new schema to allow the inclusion of other "top level" keys in responses - eg: links, pagination, etc.

Add More Fields to Author + Quote

Add some more fields to Author and Quote to make the API more lively!

(This should also serve to better demonstrate the difference between "list views" and "detail views")

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.