vcrpy: Simplify and Speed Up Python HTTP Testing

Summary

vcrpy is a Python library that automatically mocks your HTTP interactions, making testing simpler and significantly faster. Inspired by Ruby's VCR, it records HTTP requests and responses to a 'cassette' file during the first test run, then replays them in subsequent runs, eliminating actual network traffic. This approach ensures deterministic tests, allows offline development, and boosts test execution speed.

Use at your own risk

OSRepos shares public repositories for knowledge and discovery only. Any installation, execution, configuration, or use of code from these repositories is the user's own responsibility. Always review the repository, source code, dependencies, licenses, and security implications before running or installing anything. OSRepos is not responsible for issues, damages, or losses resulting from third-party repositories.

Introduction

vcrpy is a powerful Python library designed to simplify and accelerate the testing of applications that make HTTP requests. It acts as a 'cassette recorder' for your network interactions, inspired by the popular Ruby VCR library. By recording and replaying HTTP traffic, vcrpy helps developers create robust and efficient test suites.

Installation

Installing vcrpy is straightforward using pip:

pip install vcrpy

Examples

The core concept of vcrpy involves wrapping your code that makes HTTP requests within a context manager or decorating a function. The first time this code runs, vcrpy records all HTTP interactions to a YAML file, known as a 'cassette'. On subsequent runs, vcrpy intercepts these requests and serves the recorded responses from the cassette, bypassing actual network calls.

Why use vcrpy?

Using vcrpy offers several significant advantages for testing:

Work Offline: Develop and run tests without an active internet connection.
Deterministic Tests: Ensure your tests always produce the same results, free from external API flakiness or changes.
Increased Test Speed: Eliminate slow network requests, drastically speeding up your test suite execution.

If an external API changes, simply delete the old cassette files, and vcrpy will record new interactions on the next test run.