diff --git a/README.md b/README.md index cb24a77..5a57171 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,20 @@ with vcr.use_cassette('fixtures/vcr_cassettes/synopsis.yaml') as cass: assert cass.requests.keys()[0].host == 'zombo.com' ``` +The Cassette object exposes the following properties which I consider +part of the API. The fields are as follows: + +* requests: A list of vcr.Request objects containing the requests made + while this cassette was being used, ordered by the order that the + request was made. +* responses: A list of the responses made. +* play_count: The number of times this cassette has had a response + played back +* play_counts: A collections.Counter showing the number of times each + response has been played back, indexed by the request +* response_of(request): Access the response for a given request. + + ##Installation @@ -69,9 +83,10 @@ This library is a work in progress, so the API might change on you. There are probably some [bugs](https://github.com/kevin1024/vcrpy/issues?labels=bug&page=1&state=open) floating around too. ##Changelog -* 0.1.0: *backwards incompatible release - delete your old cassette - files*: This release adds the ability to access the cassette to make -assertions on it, as well as a major code refactor thanks to @dlecocq +* 0.1.0: *backwards incompatible release - delete your old cassette files*: + This release adds the ability to access the cassette to make assertions + on it, as well as a major code refactor thanks to @dlecocq. It also + fixes a couple longstanding bugs with redirects and HTTPS. * 0.0.4: If you have libyaml installed, vcrpy will use the c bindings instead. Speed up your tests! Thanks @dlecocq * 0.0.3: Add support for requests 1.2.3. Support for older versions of requests dropped (thanks @vitormazzi and @bryanhelmig)