nstarman/utilipy

View on GitHub
docs/documentation/testing.rst

Summary

Maintainability
Test Coverage
.. _utilipy-test:

=================
Running the tests
=================

The tests are written assuming they will be run with `pytest <http://doc.pytest.org/>`_ using the Astropy `custom test runner <http://docs.astropy.org/en/stable/development/testguide.html>`_. To set up a Conda environment to run the full set of tests, install ``utilipy`` or see the setup.cfg file for dependencies. Once the dependencies are installed, you can run the tests two ways:

1. By importing ``utilipy``::

    import utilipy
    utilipy.test()

2. By cloning the ``utilipy`` repository and running::

    python setup.py test


Reference/API
=============

The test functions.

.. currentmodule:: utilipy.tests
.. automodapi:: utilipy.tests
    :include-all-objects: