schemathesis


Nameschemathesis JSON
Version 3.15.6 PyPI version JSON
download
home_pagehttps://github.com/schemathesis/schemathesis
SummaryProperty-based testing framework for Open API and GraphQL based apps
upload_time2022-06-23 10:07:06
maintainerDmitry Dygalo
docs_urlNone
authorDmitry Dygalo
requires_python>=3.7,<4.0
licenseMIT
keywords pytest hypothesis openapi swagger graphql testing
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            Schemathesis
============

|Build| |Coverage| |Version| |Python versions| |Docs| |Chat| |License|

Schemathesis is a modern API testing tool for web applications built with Open API and GraphQL specifications.

It reads the application schema and generates test cases, which will ensure that your application is compliant with its schema (read more about how it works in `our research paper <https://arxiv.org/abs/2112.10328>`_).

The application under test could be written in any language; the only thing you need is a valid API schema in a supported format.

Simple to use and yet powerful to uncover hard-to-find errors thanks to the property-based testing approach backed by state-of-the-art `Hypothesis <http://hypothesis.works/>`_ library.

🚀 Schemathesis is available as a `service <https://schemathesis.io/?utm_source=github>`_, standalone CLI, or a Python library 🚀

The service enables you to verify your API schema in a few clicks, CLI gives more control.
Schemathesis.io has a free tier, so you can combine the CLI flexibility with rich visuals by uploading your test results there.

`Signup to reveal all issues on a dashboard <https://app.schemathesis.io/auth/sign-up/?utm_source=oss_readme>`_.

Features
--------

- Open API: Schema conformance, explicit examples, stateful testing;
- GraphQL: queries generation;
- Multi-worker test execution;
- Storing and replaying tests;
- ASGI / WSGI support;
- Generated code samples (cURL, Python);
- Docker image;
- Customizable checks & test generation

CLI installation
----------------

To install Schemathesis via ``pip`` run the following command:

.. code:: bash

    pip install schemathesis

This command installs the ``schemathesis`` entrypoint + ``st`` as its alias.

You can also use our Docker image without installing Schemathesis as a Python package.

Usage
-----

You can use Schemathesis in the command line directly (``st`` is an alias to ``schemathesis``):

.. code:: bash

  st run --checks all https://example.schemathesis.io/openapi.json

Or via Docker:

.. code:: bash

  docker run schemathesis/schemathesis:stable \
      run --checks all https://example.schemathesis.io/openapi.json

.. image:: https://raw.githubusercontent.com/schemathesis/schemathesis/master/img/schemathesis.gif

Or in your Python tests:

.. code:: python

    import schemathesis

    schema = schemathesis.from_uri("https://example.schemathesis.io/openapi.json")


    @schema.parametrize()
    def test_api(case):
        case.call_and_validate()

CLI is simple to use and requires no coding; the in-code approach gives more flexibility.

Both examples above will run hundreds of requests against the API under test and report all found failures and inconsistencies along with instructions to reproduce them.

💡 See a complete working example project in the ``/example`` directory. 💡

Support
-------

If you want to integrate Schemathesis into your company workflows or improve its effectiveness, feel free to reach out to `support@schemathesis.io`.

Schemathesis.io also runs workshops about effective API testing. `Signup here <https://forms.gle/epkovRdQNMCYh2Ax8>`_

Contributing
------------

Any contribution to development, testing, or any other area is highly appreciated and useful to the project.
For guidance on how to contribute to Schemathesis, see the `contributing guidelines <https://github.com/schemathesis/schemathesis/blob/master/CONTRIBUTING.rst>`_.

Links
-----

- **Documentation**: https://schemathesis.readthedocs.io/en/stable/
- **Releases**: https://pypi.org/project/schemathesis/
- **Code**: https://github.com/schemathesis/schemathesis
- **Issue tracker**: https://github.com/schemathesis/schemathesis/issues
- **Chat**: https://discord.gg/R9ASRAmHnA

Additional content:

- Research paper: `Deriving Semantics-Aware Fuzzers from Web API Schemas <https://arxiv.org/abs/2112.10328>`_ by **@Zac-HD** and **@Stranger6667**
- `An article <https://dygalo.dev/blog/schemathesis-property-based-testing-for-api-schemas/>`_ about Schemathesis by **@Stranger6667**
- `Effective API schemas testing <https://youtu.be/VVLZ25JgjD4>`_ from DevConf.cz by **@Stranger6667**
- `A video <https://www.youtube.com/watch?v=9FHRwrv-xuQ>`_ from EuroPython 2020 by **@hultner**
- `Schemathesis tutorial <https://appdev.consulting.redhat.com/tracks/contract-first/automated-testing-with-schemathesis.html>`_  with an accompanying `video <https://www.youtube.com/watch?v=4r7OC-lBKMg>`_ by Red Hat
- `Using Hypothesis and Schemathesis to Test FastAPI <https://testdriven.io/blog/fastapi-hypothesis/>`_ by **@amalshaji**

Non-English content:

- `A tutorial <https://habr.com/ru/company/oleg-bunin/blog/576496/>`_ (RUS) about Schemathesis by **@Stranger6667**

License
-------

The code in this project is licensed under `MIT license`_.
By contributing to Schemathesis, you agree that your contributions will be licensed under its MIT license.

.. |Build| image:: https://github.com/schemathesis/schemathesis/workflows/build/badge.svg
   :target: https://github.com/schemathesis/schemathesis/actions
.. |Coverage| image:: https://codecov.io/gh/schemathesis/schemathesis/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/schemathesis/schemathesis/branch/master
   :alt: codecov.io status for master branch
.. |Version| image:: https://img.shields.io/pypi/v/schemathesis.svg
   :target: https://pypi.org/project/schemathesis/
.. |Python versions| image:: https://img.shields.io/pypi/pyversions/schemathesis.svg
   :target: https://pypi.org/project/schemathesis/
.. |License| image:: https://img.shields.io/pypi/l/schemathesis.svg
   :target: https://opensource.org/licenses/MIT
.. |Chat| image:: https://img.shields.io/discord/938139740912369755
   :target: https://discord.gg/R9ASRAmHnA
   :alt: Discord
.. |Docs| image:: https://readthedocs.org/projects/schemathesis/badge/?version=stable
   :target: https://schemathesis.readthedocs.io/en/stable/?badge=stable
   :alt: Documentation Status

.. _MIT license: https://opensource.org/licenses/MIT

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/schemathesis/schemathesis",
    "name": "schemathesis",
    "maintainer": "Dmitry Dygalo",
    "docs_url": null,
    "requires_python": ">=3.7,<4.0",
    "maintainer_email": "dadygalo@gmail.com",
    "keywords": "pytest,hypothesis,openapi,swagger,graphql,testing",
    "author": "Dmitry Dygalo",
    "author_email": "dadygalo@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/e9/a1/16d49a8d6ba9f93a58cf7de5d788c6f3a9f2534d5905c514632d0f449617/schemathesis-3.15.6.tar.gz",
    "platform": null,
    "description": "Schemathesis\n============\n\n|Build| |Coverage| |Version| |Python versions| |Docs| |Chat| |License|\n\nSchemathesis is a modern API testing tool for web applications built with Open API and GraphQL specifications.\n\nIt reads the application schema and generates test cases, which will ensure that your application is compliant with its schema (read more about how it works in `our research paper <https://arxiv.org/abs/2112.10328>`_).\n\nThe application under test could be written in any language; the only thing you need is a valid API schema in a supported format.\n\nSimple to use and yet powerful to uncover hard-to-find errors thanks to the property-based testing approach backed by state-of-the-art `Hypothesis <http://hypothesis.works/>`_ library.\n\n\ud83d\ude80 Schemathesis is available as a `service <https://schemathesis.io/?utm_source=github>`_, standalone CLI, or a Python library \ud83d\ude80\n\nThe service enables you to verify your API schema in a few clicks, CLI gives more control.\nSchemathesis.io has a free tier, so you can combine the CLI flexibility with rich visuals by uploading your test results there.\n\n`Signup to reveal all issues on a dashboard <https://app.schemathesis.io/auth/sign-up/?utm_source=oss_readme>`_.\n\nFeatures\n--------\n\n- Open API: Schema conformance, explicit examples, stateful testing;\n- GraphQL: queries generation;\n- Multi-worker test execution;\n- Storing and replaying tests;\n- ASGI / WSGI support;\n- Generated code samples (cURL, Python);\n- Docker image;\n- Customizable checks & test generation\n\nCLI installation\n----------------\n\nTo install Schemathesis via ``pip`` run the following command:\n\n.. code:: bash\n\n    pip install schemathesis\n\nThis command installs the ``schemathesis`` entrypoint + ``st`` as its alias.\n\nYou can also use our Docker image without installing Schemathesis as a Python package.\n\nUsage\n-----\n\nYou can use Schemathesis in the command line directly (``st`` is an alias to ``schemathesis``):\n\n.. code:: bash\n\n  st run --checks all https://example.schemathesis.io/openapi.json\n\nOr via Docker:\n\n.. code:: bash\n\n  docker run schemathesis/schemathesis:stable \\\n      run --checks all https://example.schemathesis.io/openapi.json\n\n.. image:: https://raw.githubusercontent.com/schemathesis/schemathesis/master/img/schemathesis.gif\n\nOr in your Python tests:\n\n.. code:: python\n\n    import schemathesis\n\n    schema = schemathesis.from_uri(\"https://example.schemathesis.io/openapi.json\")\n\n\n    @schema.parametrize()\n    def test_api(case):\n        case.call_and_validate()\n\nCLI is simple to use and requires no coding; the in-code approach gives more flexibility.\n\nBoth examples above will run hundreds of requests against the API under test and report all found failures and inconsistencies along with instructions to reproduce them.\n\n\ud83d\udca1 See a complete working example project in the ``/example`` directory. \ud83d\udca1\n\nSupport\n-------\n\nIf you want to integrate Schemathesis into your company workflows or improve its effectiveness, feel free to reach out to `support@schemathesis.io`.\n\nSchemathesis.io also runs workshops about effective API testing. `Signup here <https://forms.gle/epkovRdQNMCYh2Ax8>`_\n\nContributing\n------------\n\nAny contribution to development, testing, or any other area is highly appreciated and useful to the project.\nFor guidance on how to contribute to Schemathesis, see the `contributing guidelines <https://github.com/schemathesis/schemathesis/blob/master/CONTRIBUTING.rst>`_.\n\nLinks\n-----\n\n- **Documentation**: https://schemathesis.readthedocs.io/en/stable/\n- **Releases**: https://pypi.org/project/schemathesis/\n- **Code**: https://github.com/schemathesis/schemathesis\n- **Issue tracker**: https://github.com/schemathesis/schemathesis/issues\n- **Chat**: https://discord.gg/R9ASRAmHnA\n\nAdditional content:\n\n- Research paper: `Deriving Semantics-Aware Fuzzers from Web API Schemas <https://arxiv.org/abs/2112.10328>`_ by **@Zac-HD** and **@Stranger6667**\n- `An article <https://dygalo.dev/blog/schemathesis-property-based-testing-for-api-schemas/>`_ about Schemathesis by **@Stranger6667**\n- `Effective API schemas testing <https://youtu.be/VVLZ25JgjD4>`_ from DevConf.cz by **@Stranger6667**\n- `A video <https://www.youtube.com/watch?v=9FHRwrv-xuQ>`_ from EuroPython 2020 by **@hultner**\n- `Schemathesis tutorial <https://appdev.consulting.redhat.com/tracks/contract-first/automated-testing-with-schemathesis.html>`_  with an accompanying `video <https://www.youtube.com/watch?v=4r7OC-lBKMg>`_ by Red Hat\n- `Using Hypothesis and Schemathesis to Test FastAPI <https://testdriven.io/blog/fastapi-hypothesis/>`_ by **@amalshaji**\n\nNon-English content:\n\n- `A tutorial <https://habr.com/ru/company/oleg-bunin/blog/576496/>`_ (RUS) about Schemathesis by **@Stranger6667**\n\nLicense\n-------\n\nThe code in this project is licensed under `MIT license`_.\nBy contributing to Schemathesis, you agree that your contributions will be licensed under its MIT license.\n\n.. |Build| image:: https://github.com/schemathesis/schemathesis/workflows/build/badge.svg\n   :target: https://github.com/schemathesis/schemathesis/actions\n.. |Coverage| image:: https://codecov.io/gh/schemathesis/schemathesis/branch/master/graph/badge.svg\n   :target: https://codecov.io/gh/schemathesis/schemathesis/branch/master\n   :alt: codecov.io status for master branch\n.. |Version| image:: https://img.shields.io/pypi/v/schemathesis.svg\n   :target: https://pypi.org/project/schemathesis/\n.. |Python versions| image:: https://img.shields.io/pypi/pyversions/schemathesis.svg\n   :target: https://pypi.org/project/schemathesis/\n.. |License| image:: https://img.shields.io/pypi/l/schemathesis.svg\n   :target: https://opensource.org/licenses/MIT\n.. |Chat| image:: https://img.shields.io/discord/938139740912369755\n   :target: https://discord.gg/R9ASRAmHnA\n   :alt: Discord\n.. |Docs| image:: https://readthedocs.org/projects/schemathesis/badge/?version=stable\n   :target: https://schemathesis.readthedocs.io/en/stable/?badge=stable\n   :alt: Documentation Status\n\n.. _MIT license: https://opensource.org/licenses/MIT\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Property-based testing framework for Open API and GraphQL based apps",
    "version": "3.15.6",
    "split_keywords": [
        "pytest",
        "hypothesis",
        "openapi",
        "swagger",
        "graphql",
        "testing"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "5e6f8c582fbd548276b01b108fbca607",
                "sha256": "8688030cb75e49a2c904446bfc332857a31c38f42892ef6ee81b1f7d74ff5087"
            },
            "downloads": -1,
            "filename": "schemathesis-3.15.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5e6f8c582fbd548276b01b108fbca607",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7,<4.0",
            "size": 188004,
            "upload_time": "2022-06-23T10:07:03",
            "upload_time_iso_8601": "2022-06-23T10:07:03.991664Z",
            "url": "https://files.pythonhosted.org/packages/99/e6/8346f606058e93edd47c74084685c2af47e19dacbf77dbfa35a605929466/schemathesis-3.15.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "05e5d0c24beef75d2687026b5a28aae9",
                "sha256": "46d998bc7b51a903480b47956d0163dad43b3580fe914197ca729d5e1da61be7"
            },
            "downloads": -1,
            "filename": "schemathesis-3.15.6.tar.gz",
            "has_sig": false,
            "md5_digest": "05e5d0c24beef75d2687026b5a28aae9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7,<4.0",
            "size": 153949,
            "upload_time": "2022-06-23T10:07:06",
            "upload_time_iso_8601": "2022-06-23T10:07:06.227969Z",
            "url": "https://files.pythonhosted.org/packages/e9/a1/16d49a8d6ba9f93a58cf7de5d788c6f3a9f2534d5905c514632d0f449617/schemathesis-3.15.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-06-23 10:07:06",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "schemathesis",
    "github_project": "schemathesis",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "tox": true,
    "lcname": "schemathesis"
}
        
Elapsed time: 0.51918s