mirror of
https://github.com/kevin1024/vcrpy.git
synced 2025-12-08 16:53:23 +00:00
4a8e80ee3e
* Drop support for legacy Python 2.7 * Upgrade Python syntax with pyupgrade --py3-plus * Trim testing matrix to remove python2 * re-enable python3.8 in travis as tests that are not allowed to fail * Remove some six * The future is now * Remove Python 2 imports * Add back example, but change py27 to py36 * Remove redundant compat.py * Blacken * Credit hugovk in changelog WIP Updating Sphinx Docs and AutoDoc * Fix AutoDoc and update Sphinx theme to python_doc_theme * Fix #420, autodoc even undocumented (docstring-less) method signatures * Doc theme 'nature'. Add global TOC to doc sidebar * Comment last reference to package six * Changelog is now a consistent format * Yet another documentation fix for links and title hierarchy * Start work on new SVG logo test SVG in README trying to test new SVG logo in README Apply centering Apply readme logo centering Trying to align image Trying random shit trying align right add emoji Large logo has higher priority Change title hierarchy Actually use a H1 Try again try and organise badges revert link back to point at master * updated new take on VCR logo as SVG code * Testing modern logo in docs * Add sanitize for rendering SVG * Switch to alabaster theme * Update vcrpy logo (#503) * Add credit for V4 logo changes. * Add rewind and play animation * Add svg into ReadTheDocs static assets so that it can be hosted so the animations work. * Need to embedd the SVG for ReadTheDocs somewhere so I can get the link to later embed in the README Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: Sean Bailey <sean@seanbailey.io>
72 lines
2.5 KiB
ReStructuredText
72 lines
2.5 KiB
ReStructuredText
|
|
#########
|
|
VCR.py 📼
|
|
#########
|
|
|
|
|
|
|PyPI| |Python versions| |Build Status| |CodeCov| |Gitter| |CodeStyleBlack|
|
|
|
|
----
|
|
|
|
.. image:: https://raw.github.com/kevin1024/vcrpy/master/vcr.png
|
|
:alt: vcr.py logo
|
|
:align: right
|
|
|
|
|
|
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
|
|
.. |Python versions| image:: https://img.shields.io/pypi/pyversions/vcrpy.svg
|
|
:target: https://pypi.python.org/pypi/vcrpy
|
|
.. |Build Status| image:: https://secure.travis-ci.org/kevin1024/vcrpy.svg?branch=master
|
|
:target: http://travis-ci.org/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
|
|
.. |CodeCov| image:: https://codecov.io/gh/kevin1024/vcrpy/branch/master/graph/badge.svg
|
|
:target: https://codecov.io/gh/kevin1024/vcrpy
|
|
:alt: Code Coverage Status
|
|
.. |CodeStyleBlack| image:: https://img.shields.io/badge/code%20style-black-000000.svg
|
|
:target: https://github.com/psf/black
|
|
:alt: Code Style: black
|