Improve Readme - Githubissues

kiwicom / pytest-recording

A pytest plugin that allows recording network interactions via VCR.py

MIT License

425 stars 34 forks source link

Improve Readme #49

Closed nomasprime closed 2 months ago

nomasprime commented 4 years ago

Readme doesn't document requirements, setup process, etc.

I've installed pytest-recording and hacking around now to get it working but would be great if this was all part of the Readme.

nomasprime commented 4 years ago

Of course as soon as I raised this I discovered that cassettes are being recorded just in a location I didn't expect 😄

Stranger6667 commented 4 years ago

Hi! Thank you for bringing this topic! It is definitely something we can improve :) What do you think if we'll add some kind of quickstart guide that will include all steps from an existing project without VCR / pytest-recording to fully working test suite + document how cassettes are recorded? Are there any particular points (besides those you mentioned in the first message) you think we need to address first?

nomasprime commented 4 years ago

Hey @Stranger6667, that's a great idea.

I'm new to Python and think it was mostly me not realising a couple of fairly obvious things but your suggestion probably would reduce the friction to virtually nothing 👍

Stranger6667 commented 4 years ago

Would you mind reviewing it once I'll have a prototype? Not sure when I'll have time to get into this, but probably this week

nomasprime commented 4 years ago

Thanks @Stranger6667. Of course, happy to help anyway I can.

Stranger6667 commented 4 years ago

Implementation notes for anyone willing to contribute (or for myself, when I'll get back to it):

Add the "Installation" section before "Usage";
Add installation instructions like pip install pytest-recording;
Mention that this plugin is not compatible with pytest-vcr and you need to uninstall pytest-vcr to use pytest-recording;
In the readme, add a link to the VCR-py repo where appropriate;
In the "Usage" section, add a short description of the usual workflow - add marks, run tests with --record-mode=all, see cassettes created, then rerun tests, and no network is used;
Mention that the vcr_config fixture should be in test files or in conftest.py.
Add a reference to the VCR-py documentation on recording modes