Metadata-Version: 2.4
Name: pytest-vivarium
Version: 0.1.2
Summary: Shared pytest configuration and fixtures for Vivarium projects.
Author-email: The vivarium developers <vivarium.dev@gmail.com>
License: BSD-3-Clause
Project-URL: Homepage, https://github.com/ihmeuw/vivarium-suite
Project-URL: Source, https://github.com/ihmeuw/vivarium-suite/tree/main/libs/pytest-vivarium
Classifier: Framework :: Pytest
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: BSD
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Education
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Testing
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: vivarium-dependencies[numpy,pytest]
Requires-Dist: vivarium-build-utils<5.0.0,>=4.0.0
Requires-Dist: vivarium-config-tree
Provides-Extra: cluster
Provides-Extra: test
Provides-Extra: docs
Requires-Dist: vivarium-dependencies[docutils,sphinx]; extra == "docs"
Provides-Extra: interactive
Provides-Extra: lint
Requires-Dist: vivarium-dependencies[lint]; extra == "lint"
Provides-Extra: dev
Requires-Dist: pytest-vivarium[docs,interactive,lint,test]; extra == "dev"
Provides-Extra: ci-github
Requires-Dist: pytest-vivarium[docs,lint,test]; extra == "ci-github"
Provides-Extra: ci-jenkins
Requires-Dist: pytest-vivarium[ci_github,cluster]; extra == "ci-jenkins"
Dynamic: license-file

===============
pytest-vivarium
===============

A `pytest <https://docs.pytest.org/>`_ plugin providing the shared test
configuration used across the Institute for Health Metrics and Evaluation's
Simulation Science team's `Vivarium <https://vivarium-engine.readthedocs.io/en/latest/>`_
projects: the ``slow``/``weekly``/``cluster`` markers and their ``--runslow`` /
``--runweekly`` / ``--slurm-project`` options, a memory- and CPU-aware ceiling on
``pytest -n auto`` xdist workers, and the ``no_gbd_cache`` fixture.

It is one of the libraries in the
`vivarium-suite <https://github.com/ihmeuw/vivarium-suite>`_ monorepo.

**Supported Python versions: 3.10, 3.11, 3.12**

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

.. code-block:: console

   $ pip install pytest-vivarium

pytest discovers the plugin automatically via its ``pytest11`` entry point; there
is nothing to import or enable.

Documentation
-------------

Check out the `documentation <https://pytest-vivarium.readthedocs.io/en/latest/>`_
for the full list of markers, options, and fixtures.
