mirror of
https://github.com/kevin1024/vcrpy.git
synced 2025-12-09 09:13:23 +00:00
bb8d39dd20
I noticed these were out of sync, especially weirdly one mentioning boto and the other mentioning boto3. I figure the list in the README is redundant when the Installation docs section lists the supported libraries, so I've removed it. I also: * alphabetically sorted the list * Highlighted the library names as code * Added both `boto` and `boto3` to the list since there is support for both * Removed the comment about Tornado's AsyncHTTPClient since that's an implementation detail plus the patch happens on a couple different classes * Removed the note about `http.client` being part of Python 3, because everyone is Python 3 these days anyway :)
61 lines
2.3 KiB
ReStructuredText
61 lines
2.3 KiB
ReStructuredText
|PyPI| |Python versions| |Build Status| |Waffle Ready| |Gitter|
|
|
|
|
VCR.py
|
|
======
|
|
|
|
.. image:: https://raw.github.com/kevin1024/vcrpy/master/vcr.png
|
|
:alt: vcr.py
|
|
|
|
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.
|
|
|
|
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-unittest
|
|
.. |Python versions| image:: https://img.shields.io/pypi/pyversions/vcrpy-unittest.svg
|
|
:target: https://pypi.python.org/pypi/vcrpy-unittest
|
|
.. |Build Status| image:: https://secure.travis-ci.org/kevin1024/vcrpy.png?branch=master
|
|
:target: http://travis-ci.org/kevin1024/vcrpy
|
|
.. |Waffle Ready| image:: https://badge.waffle.io/kevin1024/vcrpy.png?label=ready&title=waffle
|
|
:target: https://waffle.io/kevin1024/vcrpy
|
|
.. |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
|