Skip to main content

Generate OpenAPI spec for restible resources

Project description

This is simple tool that makes it easy to generate OpenAPI (previously Swagger) specification from the restible powered backend code.

Note

The CircleCI builds can be found here

Installation

$ pip install restible-appengine

Contributing

Cloning and setting up the development repo

$ git clone git@github.com:novopl/restible-swagger.git
$ cd restible-swagger
$ virtualenv env
$ source ./env/bin/activate
$ pip install .
$ pip install -r ops/devrequirements.txt
$ peltak git add-hooks

Note

God knows why, installing the current package with python setup.py develop or python setup.py install will cause pylint to think six is a local project package and it will throw errors about the wrong import order.

Running tests

$ peltak test

Linting

$ peltak lint

Generating docs

$ peltak docs

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for restible-swagger, version 0.3.3
Filename, size File type Python version Upload date Hashes
Filename, size restible-swagger-0.3.3.tar.gz (11.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page