pyramid-swagger


Namepyramid-swagger JSON
Version 2.9.0 PyPI version JSON
download
home_pagehttps://github.com/striglia/pyramid_swagger
SummarySwagger tools for use in pyramid webapps
upload_time2024-05-08 20:50:15
maintainerNone
docs_urlNone
authorScott Triglia
requires_pythonNone
licenseBSD 3-clause
keywords pyramid swagger validation
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            :PyPI: https://pypi.python.org/pypi/pyramid_swagger
:Documentation: http://pyramid-swagger.readthedocs.org/en/latest/
:Source: https://github.com/striglia/pyramid_swagger
:License: Copyright © 2014 Scott Triglia under the `BSD 3-clause <http://opensource.org/licenses/BSD-3-Clause>`_
:Build status:
    .. image:: https://travis-ci.org/striglia/pyramid_swagger.png?branch=master
        :target: https://travis-ci.org/striglia/pyramid_swagger?branch=master
        :alt: Travis CI
    .. image:: https://ci.appveyor.com/api/projects/status/ufmlmpwy1vj3yjgk/branch/master?svg=true
        :target: https://ci.appveyor.com/project/striglia/pyramid-swagger
        :alt: Appveyor (Windows CI)
:Current coverage on master:
    .. image:: https://coveralls.io/repos/striglia/pyramid_swagger/badge.png
        :target: https://coveralls.io/r/striglia/pyramid_swagger
:Persistent chat for questions:
    .. image:: https://badges.gitter.im/Join%20Chat.svg
        :alt: Join the chat at https://gitter.im/striglia/pyramid_swagger
        :target: https://gitter.im/striglia/pyramid_swagger?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge


pyramid_swagger
===============

This project offers convenient tools for using Swagger to define and validate
your interfaces in a Pyramid webapp.

Full documentation is available at http://pyramid-swagger.readthedocs.org/.


How to contribute
-----------------

#. Fork this repository on Github: https://help.github.com/articles/fork-a-repo/
#. Clone your forked repository: https://help.github.com/articles/cloning-a-repository/
#. Make a feature branch for your changes:

    ::

        git remote add upstream https://github.com/Yelp/pyramid_swagger.git
        git fetch upstream
        git checkout upstream/master -b my-feature-branch

#. Create and activate the virtual environment, this will provide you with all the
   libraries and tools necessary for pyramid_swagger development:

    ::

        make
        source .activate.sh

#. Make sure the test suite works before you start:

    ::

        tox -e py38    # Note: use py310 for Python 3.10, see tox.ini for possible values

#. Commit patches: http://gitref.org/basic/
#. Push to github: ``git pull && git push origin``
#. Send a pull request: https://help.github.com/articles/creating-a-pull-request/


Running a single test
*********************

Make sure you have activated the virtual environment (see above).

::

    py.test -vvv tests/tween_test.py::test_response_properties

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/striglia/pyramid_swagger",
    "name": "pyramid-swagger",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "pyramid swagger validation",
    "author": "Scott Triglia",
    "author_email": "scott.triglia@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/44/cb/0d498df44ca030d260fbb1916844dc0d233d957f5e76838784f791359a36/pyramid_swagger-2.9.0.tar.gz",
    "platform": null,
    "description": ":PyPI: https://pypi.python.org/pypi/pyramid_swagger\n:Documentation: http://pyramid-swagger.readthedocs.org/en/latest/\n:Source: https://github.com/striglia/pyramid_swagger\n:License: Copyright \u00a9 2014 Scott Triglia under the `BSD 3-clause <http://opensource.org/licenses/BSD-3-Clause>`_\n:Build status:\n    .. image:: https://travis-ci.org/striglia/pyramid_swagger.png?branch=master\n        :target: https://travis-ci.org/striglia/pyramid_swagger?branch=master\n        :alt: Travis CI\n    .. image:: https://ci.appveyor.com/api/projects/status/ufmlmpwy1vj3yjgk/branch/master?svg=true\n        :target: https://ci.appveyor.com/project/striglia/pyramid-swagger\n        :alt: Appveyor (Windows CI)\n:Current coverage on master:\n    .. image:: https://coveralls.io/repos/striglia/pyramid_swagger/badge.png\n        :target: https://coveralls.io/r/striglia/pyramid_swagger\n:Persistent chat for questions:\n    .. image:: https://badges.gitter.im/Join%20Chat.svg\n        :alt: Join the chat at https://gitter.im/striglia/pyramid_swagger\n        :target: https://gitter.im/striglia/pyramid_swagger?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge\n\n\npyramid_swagger\n===============\n\nThis project offers convenient tools for using Swagger to define and validate\nyour interfaces in a Pyramid webapp.\n\nFull documentation is available at http://pyramid-swagger.readthedocs.org/.\n\n\nHow to contribute\n-----------------\n\n#. Fork this repository on Github: https://help.github.com/articles/fork-a-repo/\n#. Clone your forked repository: https://help.github.com/articles/cloning-a-repository/\n#. Make a feature branch for your changes:\n\n    ::\n\n        git remote add upstream https://github.com/Yelp/pyramid_swagger.git\n        git fetch upstream\n        git checkout upstream/master -b my-feature-branch\n\n#. Create and activate the virtual environment, this will provide you with all the\n   libraries and tools necessary for pyramid_swagger development:\n\n    ::\n\n        make\n        source .activate.sh\n\n#. Make sure the test suite works before you start:\n\n    ::\n\n        tox -e py38    # Note: use py310 for Python 3.10, see tox.ini for possible values\n\n#. Commit patches: http://gitref.org/basic/\n#. Push to github: ``git pull && git push origin``\n#. Send a pull request: https://help.github.com/articles/creating-a-pull-request/\n\n\nRunning a single test\n*********************\n\nMake sure you have activated the virtual environment (see above).\n\n::\n\n    py.test -vvv tests/tween_test.py::test_response_properties\n",
    "bugtrack_url": null,
    "license": "BSD 3-clause",
    "summary": "Swagger tools for use in pyramid webapps",
    "version": "2.9.0",
    "project_urls": {
        "Homepage": "https://github.com/striglia/pyramid_swagger"
    },
    "split_keywords": [
        "pyramid",
        "swagger",
        "validation"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "44cb0d498df44ca030d260fbb1916844dc0d233d957f5e76838784f791359a36",
                "md5": "38330dd2093cf5f3fbeb9fa45552c2bc",
                "sha256": "ed2c04677704fb0f13575630d0fecfe4a391bb8465c138ff5d57f213508fa8a2"
            },
            "downloads": -1,
            "filename": "pyramid_swagger-2.9.0.tar.gz",
            "has_sig": false,
            "md5_digest": "38330dd2093cf5f3fbeb9fa45552c2bc",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 20309,
            "upload_time": "2024-05-08T20:50:15",
            "upload_time_iso_8601": "2024-05-08T20:50:15.369915Z",
            "url": "https://files.pythonhosted.org/packages/44/cb/0d498df44ca030d260fbb1916844dc0d233d957f5e76838784f791359a36/pyramid_swagger-2.9.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-08 20:50:15",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "striglia",
    "github_project": "pyramid_swagger",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "appveyor": true,
    "tox": true,
    "lcname": "pyramid-swagger"
}
        
Elapsed time: 0.24854s