Detailed documentation is available at http://swagger-py.readthedocs.org
Swagger.py is a Python library forked from digium/swagger-py for using Swagger defined API's.
Swagger itself is best described on the Swagger home page:
Swagger is a specification and complete framework implementation for describing, producing, consuming, and visualizing RESTful web services.
The Swagger specification defines how API's may be described using Swagger.
Install directly from github as:
$ pip install --upgrade git+git://github.com/Yelp/swagger-py
Here is a simple one to try from REPL:
from swaggerpy import client
swagger_client = client.get_client(
"http://petstore.swagger.wordnik.com/api/api-docs")
client.pet.getPetById(petId=42).result()The code is documented using Sphinx, which allows IntelliJ IDEA to do a better job at inferring types for autocompletion.
To keep things isolated, I also recommend installing (and using) virtualenv.
$ sudo pip install virtualenv $ mkdir -p ~/virtualenv $ virtualenv ~/virtualenv/swagger $ . ~/virtualenv/swagger/bin/activate
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.
$ ./setup.py develop # prep for development (install deps, launchers, etc.) $ ./setup.py nosetests # run unit tests $ ./setup.py bdist_egg # 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.