Copyright © 2014–2018 Spyder Project Contributors
Spyder-unittest is a plugin that integrates popular unit test frameworks with Spyder, allowing you to run test suites and view the results in the IDE.
The plugin supports the
unittest module in the Python standard library
as well as the
nose testing frameworks.
pytest is most complete at the moment.
The unittest plugin is available in the
spyder-ide channel in Anaconda and in PyPI,
so it can be installed with the following commands:
- Using Anaconda:
conda install -c spyder-ide spyder-unittest
- Using pip:
pip install spyder-unittest
All dependencies will be automatically installed. You have to restart Spyder before you can use the plugin.
The plugin adds an item
Run unit tests to the
Run menu in Spyder.
Click on this to run the unit tests. After you specify the testing framework
and the directory under which the tests are stored, the tests are run.
Unit testing window pane (displayed at the top of this file) will pop up
with the results. If you are using
pytest, you can double-click on a test
to view it in the editor.
If you want to run tests in a different directory or switch testing
Configure in the Options menu (cogwheel icon),
which is located in the upper right corner of the
Unit testing pane.
Development of the plugin is done at https://github.com/spyder-ide/spyder-unittest .
You can install the development version of the plugin by cloning the git repository
pip install ., possibly with the
The plugin has the following dependencies:
- spyder (obviously), at least version 3.0
- the testing framework that you will be using: pytest and/or nose
You are very welcome to submit code contributions in the form of pull requests to the issue tracker. GitHub is configured to run pull requests automatically against the test suite and against several automatic style checkers using ciocheck. The style checkers can be rather finicky so you may want to install ciocheck locally and run them before submitting the code.
Everyone is welcome to contribute! The document Contributing to Spyder also applies to the unittest plugin.
We are grateful to the entire Spyder community for their support, without which this plugin and the whole of Spyder would be a lot less awesome.