Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Add installation step in README and correct title in CONTRIBUTING #144

Merged
merged 1 commit into from
Jul 9, 2024
Merged

docs: Add installation step in README and correct title in CONTRIBUTING #144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ It would be awesome if you can submit a failing test that demonstrates the probl
.. _fixbugs:

Submitting Pull Requests
-----------------------
------------------------

#. Fork the repository.
#. Enable and install `pre-commit <https://pre-commit.com>`_ to ensure style-guides and code checks are followed.
Expand Down
12 changes: 12 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,18 @@ Features
- Network access blocking;
- The ``rewrite`` recording mode that rewrites cassettes from scratch.

Installation
------------

This project can be installed via pip:

.. code:: bash

pip install pytest-recording

⚠️This project is not compatible with `pytest-vcr`, make sure to uninstall before ⚠️


Usage
-----

Expand Down