asgillmor / swagger-py Goto Github PK

From Swagger's home page:

Swagger is a specification and complete framework implementation for describing, producing, consuming, and visualizing RESTful web services.

Client libraries can automatically be generated from the Swagger specification, however Swagger-py aims to be a compleate replacement for code generation (swagger-codegen).

Swagger.py is a forked from digium/swagger-py for using Swagger defined API's.

from swaggerpy import client
swagger_client = client.get_client("http://petstore.swagger.wordnik.com/api/api-docs")
swagger_client.pet.getPetById(petId=42).result()

More documentation is available at http://swagger-py.readthedocs.org

$ pip install --upgrade git+git://github.com/Yelp/swagger-py

Code is documented using Sphinx.

virtualenv. is recommended to keep dependencies and libraries isolated.

Setuptools is used for building. Nose is used for unit testing, with the coverage plugin installed to generated code coverage reports. Pass --with-coverage to generate the code coverage report. HTML versions of the reports are put in cover/index.html.

$ make dev   # prep for development (install deps, launchers, etc.)
$ make test  # run unit tests
$ make build # build distributable

Copyright (c) 2013, Digium, Inc. All rights reserved. Copyright (c) 2014, Yelp, Inc. All rights reserved.

Swagger.py is licensed with a BSD 3-Clause License.