https://github.com/domdfcoding/tox-isolation
Runs pytest in isolation.
https://github.com/domdfcoding/tox-isolation
python
Last synced: 4 months ago
JSON representation
Runs pytest in isolation.
- Host: GitHub
- URL: https://github.com/domdfcoding/tox-isolation
- Owner: domdfcoding
- License: mit
- Created: 2020-11-02T13:27:33.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-30T11:50:11.000Z (7 months ago)
- Last Synced: 2024-12-19T23:17:23.930Z (6 months ago)
- Topics: python
- Language: Python
- Homepage:
- Size: 64.5 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
README
##############
tox-isolation
##############
.. start short_desc
**Runs pytest in isolation.**
.. end short_desc
.. start shields
.. list-table::
:stub-columns: 1
:widths: 10 90
* - Tests
- |actions_linux| |actions_windows| |actions_macos| |coveralls|
* - Activity
- |commits-latest| |commits-since| |maintained|
* - QA
- |codefactor| |actions_flake8| |actions_mypy|
* - Other
- |license| |language| |requires|
.. |actions_linux| image:: https://github.com/domdfcoding/tox-isolation/workflows/Linux/badge.svg
:target: https://github.com/domdfcoding/tox-isolation/actions?query=workflow%3A%22Linux%22
:alt: Linux Test Status
.. |actions_windows| image:: https://github.com/domdfcoding/tox-isolation/workflows/Windows/badge.svg
:target: https://github.com/domdfcoding/tox-isolation/actions?query=workflow%3A%22Windows%22
:alt: Windows Test Status
.. |actions_macos| image:: https://github.com/domdfcoding/tox-isolation/workflows/macOS/badge.svg
:target: https://github.com/domdfcoding/tox-isolation/actions?query=workflow%3A%22macOS%22
:alt: macOS Test Status
.. |actions_flake8| image:: https://github.com/domdfcoding/tox-isolation/workflows/Flake8/badge.svg
:target: https://github.com/domdfcoding/tox-isolation/actions?query=workflow%3A%22Flake8%22
:alt: Flake8 Status
.. |actions_mypy| image:: https://github.com/domdfcoding/tox-isolation/workflows/mypy/badge.svg
:target: https://github.com/domdfcoding/tox-isolation/actions?query=workflow%3A%22mypy%22
:alt: mypy status
.. |requires| image:: https://dependency-dash.repo-helper.uk/github/domdfcoding/tox-isolation/badge.svg
:target: https://dependency-dash.repo-helper.uk/github/domdfcoding/tox-isolation/
:alt: Requirements Status
.. |coveralls| image:: https://img.shields.io/coveralls/github/domdfcoding/tox-isolation/master?logo=coveralls
:target: https://coveralls.io/github/domdfcoding/tox-isolation?branch=master
:alt: Coverage
.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/domdfcoding/tox-isolation?logo=codefactor
:target: https://www.codefactor.io/repository/github/domdfcoding/tox-isolation
:alt: CodeFactor Grade
.. |license| image:: https://img.shields.io/github/license/domdfcoding/tox-isolation
:target: https://github.com/domdfcoding/tox-isolation/blob/master/LICENSE
:alt: License
.. |language| image:: https://img.shields.io/github/languages/top/domdfcoding/tox-isolation
:alt: GitHub top language
.. |commits-since| image:: https://img.shields.io/github/commits-since/domdfcoding/tox-isolation/v0.0.0
:target: https://github.com/domdfcoding/tox-isolation/pulse
:alt: GitHub commits since tagged version
.. |commits-latest| image:: https://img.shields.io/github/last-commit/domdfcoding/tox-isolation
:target: https://github.com/domdfcoding/tox-isolation/commit/master
:alt: GitHub last commit
.. |maintained| image:: https://img.shields.io/maintenance/yes/2024
:alt: Maintenance
.. end shields
Usage
----------
``tox-isolation`` runs pytest tests in isolation by copying the test directory into a temporary directory
and running the tests from there. This prevents pytest from trying to use the source files for the project,
instead forcing it to use the version installed in the virtualenv by tox.
The files copied into the temporary directory are controlled bu the ``isolate_dirs`` option in the
``testenv`` section of ``tox.ini``. This allows the files to be customised on a per-env basis.
If the option is undefined the isolation is disabled.
Relative paths are taken to be relative to the current working directory.
**Example:**
.. code-block:: ini
# tox.ini
[testenv]
deps = -r{toxinidir}/tests/requirements.txt
commands = python -m pytest tests/ {posargs}
isolate_dirs = {toxinidir}/tests
Installation
--------------
.. start installation
``tox-isolation`` can be installed from GitHub.
To install with ``pip``:
.. code-block:: bash
$ python -m pip install git+https://github.com/domdfcoding/tox-isolation
.. end installation