forked from gitter-badger/swagger-parser
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
32 changed files
with
2,647 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# http://editorconfig.org | ||
|
||
root = true | ||
|
||
[*] | ||
indent_style = space | ||
indent_size = 4 | ||
trim_trailing_whitespace = true | ||
insert_final_newline = true | ||
charset = utf-8 | ||
end_of_line = lf | ||
|
||
[*.bat] | ||
indent_style = tab | ||
end_of_line = crlf | ||
|
||
[LICENSE] | ||
insert_final_newline = false | ||
|
||
[Makefile] | ||
indent_style = tab |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -57,6 +57,3 @@ docs/_build/ | |
|
||
# PyBuilder | ||
target/ | ||
|
||
#Ipython Notebook | ||
.ipynb_checkpoints |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
language: python | ||
env: | ||
- TOXENV=py35 | ||
- TOXENV=py34 | ||
- TOXENV=py33 | ||
- TOXENV=py27 | ||
- TOXENV=py26 | ||
- TOXENV=pypy | ||
install: pip install -U tox | ||
script: tox | ||
deploy: | ||
provider: pypi | ||
distributions: sdist bdist_wheel | ||
user: cyprieng | ||
password: | ||
secure: XITH5fCPmchCp8C2DHaQJYZfsgDSLnicVpZ7EYW/hh+UHvwTwtk/ueAypi38wt0lzciL61t2Z2YPTjQJchOtUGPGQ3FwMiqMHS4+W0H2aj45jPWttJ3yqvP7k9eEqjUeDJHUX8J3HK6JkofFnVJjxCiUUmsP30U7tF1oWqcHoI/fUlH0H6rJJLT0So/1q1BqWnxtvxhPcUsiV6R1A6Eo/tBu84NtIBZfTtcFVyUEWhgCGhJFnN0Gcm1irWiO5bWSA0AJz/YhRujVzssp7ccVZExxmu4A1zwKO0f8z6NUoDIkDZU9eQze9AfB2b24NWaYwCV8DpIGbvJZabKfxbDm1D9BI/Kjfzj5Pl7NLN+RrB3kya8fuFkm8jniuRfW9FI7zgmtm7s5kJLxu+2mXcVaagcXx3Qp8a7z4kOsxB2DMqUxuBqz46NYk8CYTgSFDY3per8DS0vIzdOItYVyNv6jiqCUhJ0+ybYJQTSE8dz5Sw0Kziv9A4PTDl1zaHDJTGCNrO3U30nhsSLAbXeWsSxOXGoO1ZUlciz3XxqrPn6NFIJaQh2EYx5xXb9jkPIOBtlLJ/jzGZdwxgYEr7Fy3EQQtf64rQxp2H/ffjOHkUPNCxdGGW43XLCm1AW+l7rxRmXa24Eo+SzviWVrq8AtePmGm40Gxf2VdOAbXoScHr8a/+g= | ||
on: | ||
tags: true | ||
repo: Trax-air/swagger-parser | ||
condition: $TOXENV == py27 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
======= | ||
Credits | ||
======= | ||
|
||
Development Lead | ||
---------------- | ||
|
||
* Cyprien Guillemot <[email protected]> | ||
|
||
Contributors | ||
------------ | ||
|
||
None yet. Why not be the first? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,113 @@ | ||
.. highlight:: shell | ||
|
||
============ | ||
Contributing | ||
============ | ||
|
||
Contributions are welcome, and they are greatly appreciated! Every | ||
little bit helps, and credit will always be given. | ||
|
||
You can contribute in many ways: | ||
|
||
Types of Contributions | ||
---------------------- | ||
|
||
Report Bugs | ||
~~~~~~~~~~~ | ||
|
||
Report bugs at https://github.com/cyprieng/swagger_parser/issues. | ||
|
||
If you are reporting a bug, please include: | ||
|
||
* Your operating system name and version. | ||
* Any details about your local setup that might be helpful in troubleshooting. | ||
* Detailed steps to reproduce the bug. | ||
|
||
Fix Bugs | ||
~~~~~~~~ | ||
|
||
Look through the GitHub issues for bugs. Anything tagged with "bug" | ||
is open to whoever wants to implement it. | ||
|
||
Implement Features | ||
~~~~~~~~~~~~~~~~~~ | ||
|
||
Look through the GitHub issues for features. Anything tagged with "feature" | ||
is open to whoever wants to implement it. | ||
|
||
Write Documentation | ||
~~~~~~~~~~~~~~~~~~~ | ||
|
||
Swagger Parser could always use more documentation, whether as part of the | ||
official Swagger Parser docs, in docstrings, or even on the web in blog posts, | ||
articles, and such. | ||
|
||
Submit Feedback | ||
~~~~~~~~~~~~~~~ | ||
|
||
The best way to send feedback is to file an issue at https://github.com/cyprieng/swagger_parser/issues. | ||
|
||
If you are proposing a feature: | ||
|
||
* Explain in detail how it would work. | ||
* Keep the scope as narrow as possible, to make it easier to implement. | ||
* Remember that this is a volunteer-driven project, and that contributions | ||
are welcome :) | ||
|
||
Get Started! | ||
------------ | ||
|
||
Ready to contribute? Here's how to set up `swagger_parser` for local development. | ||
|
||
1. Fork the `swagger_parser` repo on GitHub. | ||
2. Clone your fork locally:: | ||
|
||
$ git clone [email protected]:your_name_here/swagger_parser.git | ||
|
||
3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:: | ||
|
||
$ mkvirtualenv swagger_parser | ||
$ cd swagger_parser/ | ||
$ python setup.py develop | ||
|
||
4. Create a branch for local development:: | ||
|
||
$ git checkout -b name-of-your-bugfix-or-feature | ||
|
||
Now you can make your changes locally. | ||
|
||
5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:: | ||
|
||
$ flake8 swagger_parser tests | ||
$ python setup.py test | ||
$ tox | ||
|
||
To get flake8 and tox, just pip install them into your virtualenv. | ||
|
||
6. Commit your changes and push your branch to GitHub:: | ||
|
||
$ git add . | ||
$ git commit -m "Your detailed description of your changes." | ||
$ git push origin name-of-your-bugfix-or-feature | ||
|
||
7. Submit a pull request through the GitHub website. | ||
|
||
Pull Request Guidelines | ||
----------------------- | ||
|
||
Before you submit a pull request, check that it meets these guidelines: | ||
|
||
1. The pull request should include tests. | ||
2. If the pull request adds functionality, the docs should be updated. Put | ||
your new functionality into a function with a docstring, and add the | ||
feature to the list in README.rst. | ||
3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check | ||
https://travis-ci.org/cyprieng/swagger_parser/pull_requests | ||
and make sure that the tests pass for all supported Python versions. | ||
|
||
Tips | ||
---- | ||
|
||
To run a subset of tests:: | ||
|
||
$ python -m unittest tests.test_swagger_parser |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
======= | ||
History | ||
======= | ||
|
||
0.1 (2016-1-28) | ||
------------------ | ||
|
||
* First release on PyPI. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
include AUTHORS.rst | ||
include CONTRIBUTING.rst | ||
include HISTORY.rst | ||
include LICENSE | ||
include README.rst | ||
|
||
recursive-include tests * | ||
recursive-exclude * __pycache__ | ||
recursive-exclude * *.py[co] | ||
|
||
recursive-include docs *.rst conf.py Makefile make.bat |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
.PHONY: clean-pyc clean-build docs clean | ||
define BROWSER_PYSCRIPT | ||
import os, webbrowser, sys | ||
try: | ||
from urllib import pathname2url | ||
except: | ||
from urllib.request import pathname2url | ||
|
||
webbrowser.open("file://" + pathname2url(os.path.abspath(sys.argv[1]))) | ||
endef | ||
export BROWSER_PYSCRIPT | ||
BROWSER := python -c "$$BROWSER_PYSCRIPT" | ||
|
||
help: | ||
@echo "clean - remove all build, test, coverage and Python artifacts" | ||
@echo "clean-build - remove build artifacts" | ||
@echo "clean-pyc - remove Python file artifacts" | ||
@echo "clean-test - remove test and coverage artifacts" | ||
@echo "lint - check style with flake8" | ||
@echo "test - run tests quickly with the default Python" | ||
@echo "test-all - run tests on every Python version with tox" | ||
@echo "coverage - check code coverage quickly with the default Python" | ||
@echo "docs - generate Sphinx HTML documentation, including API docs" | ||
@echo "release - package and upload a release" | ||
@echo "dist - package" | ||
@echo "install - install the package to the active Python's site-packages" | ||
|
||
clean: clean-build clean-pyc clean-test | ||
|
||
clean-build: | ||
rm -fr build/ | ||
rm -fr dist/ | ||
rm -fr .eggs/ | ||
find . -name '*.egg-info' -exec rm -fr {} + | ||
find . -name '*.egg' -exec rm -f {} + | ||
|
||
clean-pyc: | ||
find . -name '*.pyc' -exec rm -f {} + | ||
find . -name '*.pyo' -exec rm -f {} + | ||
find . -name '*~' -exec rm -f {} + | ||
find . -name '__pycache__' -exec rm -fr {} + | ||
|
||
clean-test: | ||
rm -fr .tox/ | ||
rm -f .coverage | ||
rm -fr htmlcov/ | ||
|
||
lint: | ||
flake8 swagger_parser tests | ||
|
||
test: | ||
python setup.py test | ||
|
||
test-all: | ||
tox | ||
|
||
coverage: | ||
coverage run --source swagger_parser setup.py test | ||
coverage report -m | ||
coverage html | ||
$(BROWSER) htmlcov/index.html | ||
|
||
docs: | ||
rm -f docs/swagger_parser.rst | ||
rm -f docs/modules.rst | ||
sphinx-apidoc -o docs/ swagger_parser | ||
$(MAKE) -C docs clean | ||
$(MAKE) -C docs html | ||
$(BROWSER) docs/_build/html/index.html | ||
|
||
servedocs: docs | ||
watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D . | ||
|
||
release: clean | ||
python setup.py sdist upload | ||
python setup.py bdist_wheel upload | ||
|
||
dist: clean | ||
python setup.py sdist | ||
python setup.py bdist_wheel | ||
ls -l dist | ||
|
||
install: clean | ||
python setup.py install |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
[![Build Status](https://travis-ci.org/Trax-air/swagger-parser.svg?branch=master)](https://travis-ci.org/Trax-air/swagger-parser) | ||
|
||
swagger-parser | ||
============== | ||
|
||
Swagger-parser is a python module giving you access to some interesting data about your swagger file. Like getting a dictionary example from a definition name, get the definition of a dictionary... | ||
|
||
Example Usage | ||
------------- | ||
|
||
```Python | ||
from swagger_parser import SwaggerParser | ||
parser = SwaggerParser(swagger_path='swagger_path') # Init with file | ||
parser = SwaggerParser(swagger_dict={}) # Init with dictionary | ||
# Get an example of dict for the definition Foo | ||
parser.definitions_example.get('Foo') | ||
# Get the definition of a dictionary | ||
test = { | ||
'foo': 'bar' | ||
} | ||
parser.get_dict_definition(test) | ||
# Validate the definition of a dict | ||
parser.validate_definition('Foo', test) | ||
# Validate that the given data match a path specification | ||
parser.validate_request('/foo', 'post', body=test, query={'foo': 'bar'}) | ||
# Get the possible return value of a path | ||
# It will return a dictionary with keys as status_code | ||
# and value as example of return value. | ||
parser.get_request_data('/foo', 'post', body=test) | ||
# Get an example of a correct body for a path | ||
parser.get_send_request_correct_body('/foo', 'post') | ||
``` | ||
|
||
Setup | ||
----- | ||
|
||
`make install` | ||
|
||
License | ||
------- | ||
|
||
swagger-parser is licensed under [GPL 3.0](http://opensource.org/licenses/GPL-3.0). |
Oops, something went wrong.