Cache HTTP responses for docs with VCR#201
Open
Mr0grog wants to merge 1 commit into
Open
Conversation
When a lot of builds happen at once, our docs frequently start to fail because of rate limits with the Wayback Machine. Docs builds are also often slow. Both of these are because we use ipython to execute and show the results of code samples in the tutorial, which means we hit live Wayback Machine APIs. This solves the problem by recording and replaying the API responses using VCR, just like we do for tests. Fixes #188.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
When a lot of builds happen at once, our docs frequently start to fail because of rate limits with the Wayback Machine. Docs builds are also often slow. Both of these are because we use ipython to execute and show the results of code samples in the tutorial, which means we hit live Wayback Machine APIs. This solves the problem by recording and replaying the API responses using VCR, just like we do for tests.
I couldn’t figure out a way to do this entirely with the
ipython_execlinessetting, since it doesn’t seem to give you a way to execute cleanup/teardown code, and VCR needs that to write out its results. So I wound up with a kind of weird hybrid solution, where I useipython_execlinesto set a directory path to read/write VCR cassettes in, and then have suppressed (hidden) ipython directives at the start and end of the tutorial to begin and clean up VCR recording and replay. It’s not the prettiest approach, but it works.Fixes #188.