https://github.com/astropy/pytest-astropy
Metapackage for all the testing machinery used by the Astropy Project
https://github.com/astropy/pytest-astropy
Last synced: about 1 year ago
JSON representation
Metapackage for all the testing machinery used by the Astropy Project
- Host: GitHub
- URL: https://github.com/astropy/pytest-astropy
- Owner: astropy
- License: bsd-3-clause
- Created: 2017-09-20T18:48:38.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2025-05-01T04:32:42.000Z (about 1 year ago)
- Last Synced: 2025-05-08T10:24:21.245Z (about 1 year ago)
- Language: Python
- Size: 83 KB
- Stars: 5
- Watchers: 16
- Forks: 13
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.rst
- License: LICENSE.rst
Awesome Lists containing this project
README
==============
pytest-astropy
==============
.. image:: https://zenodo.org/badge/104255122.svg
:target: https://zenodo.org/badge/latestdoi/104255122
:alt: Zenodo DOI
This is a meta-package that pulls in the dependencies that are used by
`astropy`_ and some `affiliated packages`_ for testing. It can also be used for
testing packages that are not affiliated with the Astropy project.
This package also provides pytest markers for cpu and memory intensive tests
(``pytest.mark.slow`` and ``pytest.mark.hugemem``). Tests marked with those
markers are not run by default, can be run with the other tests with
``--run-slow`` and ``--run-hugemem``, and can be run separately with ``-m slow``
and ``-m hugemem``.
The package also provides the short option ``-R`` for ``--remote-data``.
.. _astropy: https://docs.astropy.org/en/latest/
.. _affiliated packages: https://astropy.org/affiliated
Dependencies
------------
The following dependencies are installed by this package:
* The `pytest`_ testing framework for Python.
* `pytest-astropy-header`_, a ``pytest`` plugin used for custom test header.
* `pytest-remotedata`_, a ``pytest`` plugin used for controlling access to data
files hosted online.
* `pytest-doctestplus`_, a ``pytest`` plugin that provides advanced features
for testing example code in documentation.
* `pytest-arraydiff`_, a ``pytest`` plugin that enables the generation and
comparison of data arrays produced during unit tests.
* `pytest-filter-subpackage`_, a ``pytest`` plugin that adds a ``-P`` option to
pytest to filter by sub-package.
* `pytest-mock`_, a thin-wrapper around the mock package for easier use
with ``pytest``.
* `pytest-cov`_, a ``pytest`` plugin to measure test coverage.
* `hypothesis`_, a Python library for property based testing.
.. _pytest: https://doc.pytest.org
.. _pytest-astropy-header: https://github.com/astropy/pytest-astropy-header
.. _pytest-remotedata: https://github.com/astropy/pytest-remotedata
.. _pytest-doctestplus: https://github.com/astropy/pytest-doctestplus
.. _pytest-arraydiff: https://github.com/astropy/pytest-arraydiff
.. _pytest-filter-subpackage: https://github.com/astropy/pytest-filter-subpackage
.. _pytest-mock: https://github.com/pytest-dev/pytest-mock
.. _pytest-cov: https://github.com/pytest-dev/pytest-cov
.. _hypothesis: https://hypothesis.readthedocs.io
Installation
------------
The ``pytest-astropy`` plugin can be installed using ``pip``::
$ pip install pytest-astropy
It is also possible to install the latest development version from the source
repository::
$ git clone https://github.com/astropy/pytest-astropy
$ cd pytest-astropy
$ python ./setup.py install
In either case, the plugin will automatically be registered for use with
``pytest``.
Development Status
------------------
Questions, bug reports, and feature requests can be submitted on `github`_.
.. _github: https://github.com/astropy/pytest-astropy
License
-------
This package is licensed under a 3-clause BSD style license - see the
``LICENSE.rst`` file.