Skip to content

Commit

Permalink
Merge pull request #142 from rantav/revert-141-pipeline
Browse files Browse the repository at this point in the history
Revert "Pipeline"
  • Loading branch information
niall-byrne authored Feb 10, 2020
2 parents 10fbe74 + ad65f22 commit 666c330
Show file tree
Hide file tree
Showing 67 changed files with 815 additions and 4,017 deletions.
1 change: 0 additions & 1 deletion .bandit.rc

This file was deleted.

12 changes: 0 additions & 12 deletions .coveragerc

This file was deleted.

5 changes: 0 additions & 5 deletions .dockerignore

This file was deleted.

15 changes: 0 additions & 15 deletions .flake8

This file was deleted.

37 changes: 0 additions & 37 deletions .github/workflows/docker27.yml

This file was deleted.

37 changes: 0 additions & 37 deletions .github/workflows/docker37.yml

This file was deleted.

141 changes: 20 additions & 121 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,139 +1,38 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
pip-wheel-metadata/
share/python-wheels/
*.egg-info/
.installed.cfg
# Packages
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
*.egg-info
dist
build
eggs
parts
bin
var
sdist
develop-eggs
.installed.cfg
lib
lib64
__pycache__

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
.tox
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
.python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# PEP 582; used by e.g. github.com/David-OConnor/pyflow
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# Overrides
override.env

# Pycharm
.idea

# Archives
.archive
# Mr Developer
.mr.developer.cfg
.project
.pydevproject

*.iml
9 changes: 0 additions & 9 deletions .isort.cfg

This file was deleted.

46 changes: 0 additions & 46 deletions CODE_OF_CONDUCT.md

This file was deleted.

12 changes: 0 additions & 12 deletions CONTRIBUTING.md

This file was deleted.

File renamed without changes.
11 changes: 0 additions & 11 deletions Pipfile

This file was deleted.

22 changes: 5 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# flask-restful-swagger

[![flask_restful_swagger-automation](https://github.com/rantav/flask-restful-swagger/workflows/flask_restful_swagger%20Python2.7/badge.svg)](https://github.com/rantav/flask-restful-swagger/actions)<br>
[![flask_restful_swagger-automation](https://github.com/rantav/flask-restful-swagger/workflows/flask_restful_swagger%20Python3.7/badge.svg)](https://github.com/rantav/flask-restful-swagger/actions)<br>
### We have a new project lead!
We have a new project lead, @niall-byrne (Dec 2015), thank you Niall!


## What is flask-restful-swagger?
flask-restful-swagger is a wrapper for [flask-restful](http://flask-restful.readthedocs.org/en/latest/) which enables [swagger](https://developers.helloreverb.com/swagger/) support.

In essence, you just need to wrap the Api instance and add a few python decorators to get full swagger support.
In essense, you just need to wrap the Api instance and add a few python decorators to get full swagger support.

## Installation:
## How to:
Install:

```
Expand All @@ -18,19 +18,7 @@ pip install flask-restful-swagger
(This installs flask-restful as well)


## See Some Quick Examples:

```bash
PYTHONPATH=. python examples/basic.py
PYTHONPATH=. python examples/blueprints.py
PYTHONPATH=. python examples/inheritance.py
```

Browse to: [http://localhost:5000/api/spec.html](http://localhost:5000/api/spec.html)

## How To:

In your program, where you'd usually just use flask-restful, add just a little bit of sauce and get a swagger spec out.
And in your program, where you'd usually just use flask-restful, add just a little bit of sauce and get a swagger spec out.


```python
Expand Down
Loading

0 comments on commit 666c330

Please sign in to comment.