| Name | vcrpy JSON |
| Version |
6.0.2
JSON |
| download |
| home_page | https://github.com/kevin1024/vcrpy |
| Summary | Automatically mock your HTTP interactions to simplify and speed up testing |
| upload_time | 2024-10-07 13:07:31 |
| maintainer | None |
| docs_url | None |
| author | Kevin McCarthy |
| requires_python | >=3.8 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
###########
VCR.py 📼
###########
|PyPI| |Python versions| |Build Status| |CodeCov| |Gitter|
----
.. image:: https://vcrpy.readthedocs.io/en/latest/_images/vcr.svg
:alt: vcr.py logo
This is a Python version of `Ruby's VCR
library <https://github.com/vcr/vcr>`__.
Source code
https://github.com/kevin1024/vcrpy
Documentation
https://vcrpy.readthedocs.io/
Rationale
---------
VCR.py simplifies and speeds up tests that make HTTP requests. The
first time you run code that is inside a VCR.py context manager or
decorated function, VCR.py records all HTTP interactions that take
place through the libraries it supports and serializes and writes them
to a flat file (in yaml format by default). This flat file is called a
cassette. When the relevant piece of code is executed again, VCR.py
will read the serialized requests and responses from the
aforementioned cassette file, and intercept any HTTP requests that it
recognizes from the original test run and return the responses that
corresponded to those requests. This means that the requests will not
actually result in HTTP traffic, which confers several benefits
including:
- The ability to work offline
- Completely deterministic tests
- Increased test execution speed
If the server you are testing against ever changes its API, all you need
to do is delete your existing cassette files, and run your tests again.
VCR.py will detect the absence of a cassette file and once again record
all HTTP interactions, which will update them to correspond to the new
API.
Usage with Pytest
-----------------
There is a library to provide some pytest fixtures called pytest-recording https://github.com/kiwicom/pytest-recording
License
-------
This library uses the MIT license. See `LICENSE.txt <LICENSE.txt>`__ for
more details
.. |PyPI| image:: https://img.shields.io/pypi/v/vcrpy.svg
:target: https://pypi.python.org/pypi/vcrpy
.. |Python versions| image:: https://img.shields.io/pypi/pyversions/vcrpy.svg
:target: https://pypi.python.org/pypi/vcrpy
.. |Build Status| image:: https://github.com/kevin1024/vcrpy/actions/workflows/main.yml/badge.svg
:target: https://github.com/kevin1024/vcrpy/actions
.. |Gitter| image:: https://badges.gitter.im/Join%20Chat.svg
:alt: Join the chat at https://gitter.im/kevin1024/vcrpy
:target: https://gitter.im/kevin1024/vcrpy?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
.. |CodeCov| image:: https://codecov.io/gh/kevin1024/vcrpy/branch/master/graph/badge.svg
:target: https://codecov.io/gh/kevin1024/vcrpy
:alt: Code Coverage Status
Raw data
{
"_id": null,
"home_page": "https://github.com/kevin1024/vcrpy",
"name": "vcrpy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Kevin McCarthy",
"author_email": "me@kevinmccarthy.org",
"download_url": "https://files.pythonhosted.org/packages/16/4e/fff59599826793f9e3460c22c0af0377abb27dc9781a7d5daca8cb03da25/vcrpy-6.0.2.tar.gz",
"platform": null,
"description": "\n###########\nVCR.py \ud83d\udcfc\n###########\n\n\n|PyPI| |Python versions| |Build Status| |CodeCov| |Gitter|\n\n----\n\n.. image:: https://vcrpy.readthedocs.io/en/latest/_images/vcr.svg\n :alt: vcr.py logo\n\n\nThis is a Python version of `Ruby's VCR\nlibrary <https://github.com/vcr/vcr>`__.\n\nSource code\n https://github.com/kevin1024/vcrpy\n\nDocumentation\n https://vcrpy.readthedocs.io/\n\nRationale\n---------\n\nVCR.py simplifies and speeds up tests that make HTTP requests. The\nfirst time you run code that is inside a VCR.py context manager or\ndecorated function, VCR.py records all HTTP interactions that take\nplace through the libraries it supports and serializes and writes them\nto a flat file (in yaml format by default). This flat file is called a\ncassette. When the relevant piece of code is executed again, VCR.py\nwill read the serialized requests and responses from the\naforementioned cassette file, and intercept any HTTP requests that it\nrecognizes from the original test run and return the responses that\ncorresponded to those requests. This means that the requests will not\nactually result in HTTP traffic, which confers several benefits\nincluding:\n\n- The ability to work offline\n- Completely deterministic tests\n- Increased test execution speed\n\nIf the server you are testing against ever changes its API, all you need\nto do is delete your existing cassette files, and run your tests again.\nVCR.py will detect the absence of a cassette file and once again record\nall HTTP interactions, which will update them to correspond to the new\nAPI.\n\nUsage with Pytest\n-----------------\n\nThere is a library to provide some pytest fixtures called pytest-recording https://github.com/kiwicom/pytest-recording\n\nLicense\n-------\n\nThis library uses the MIT license. See `LICENSE.txt <LICENSE.txt>`__ for\nmore details\n\n.. |PyPI| image:: https://img.shields.io/pypi/v/vcrpy.svg\n :target: https://pypi.python.org/pypi/vcrpy\n.. |Python versions| image:: https://img.shields.io/pypi/pyversions/vcrpy.svg\n :target: https://pypi.python.org/pypi/vcrpy\n.. |Build Status| image:: https://github.com/kevin1024/vcrpy/actions/workflows/main.yml/badge.svg\n :target: https://github.com/kevin1024/vcrpy/actions\n.. |Gitter| image:: https://badges.gitter.im/Join%20Chat.svg\n :alt: Join the chat at https://gitter.im/kevin1024/vcrpy\n :target: https://gitter.im/kevin1024/vcrpy?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge\n.. |CodeCov| image:: https://codecov.io/gh/kevin1024/vcrpy/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/kevin1024/vcrpy\n :alt: Code Coverage Status\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Automatically mock your HTTP interactions to simplify and speed up testing",
"version": "6.0.2",
"project_urls": {
"Homepage": "https://github.com/kevin1024/vcrpy"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "daed25d19705791d3fccc84423d564695421a75b4e08e8ab15a004a49068742d",
"md5": "7625892d3b95215168a191bfa6e9f164",
"sha256": "40370223861181bc76a5e5d4b743a95058bb1ad516c3c08570316ab592f56cad"
},
"downloads": -1,
"filename": "vcrpy-6.0.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "7625892d3b95215168a191bfa6e9f164",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 42431,
"upload_time": "2024-10-07T13:07:30",
"upload_time_iso_8601": "2024-10-07T13:07:30.475213Z",
"url": "https://files.pythonhosted.org/packages/da/ed/25d19705791d3fccc84423d564695421a75b4e08e8ab15a004a49068742d/vcrpy-6.0.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "164efff59599826793f9e3460c22c0af0377abb27dc9781a7d5daca8cb03da25",
"md5": "67c4b26974f26e35bcadc40eca796570",
"sha256": "88e13d9111846745898411dbc74a75ce85870af96dd320d75f1ee33158addc09"
},
"downloads": -1,
"filename": "vcrpy-6.0.2.tar.gz",
"has_sig": false,
"md5_digest": "67c4b26974f26e35bcadc40eca796570",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 85472,
"upload_time": "2024-10-07T13:07:31",
"upload_time_iso_8601": "2024-10-07T13:07:31.617139Z",
"url": "https://files.pythonhosted.org/packages/16/4e/fff59599826793f9e3460c22c0af0377abb27dc9781a7d5daca8cb03da25/vcrpy-6.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 13:07:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kevin1024",
"github_project": "vcrpy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "vcrpy"
}
