spyder-ide/spyder-unittest

Name: spyder-unittest

Owner: Spyder IDE

Description: A plugin for Spyder to run tests and view the results

Created: 2015-12-06 16:48:54.0

Updated: 2018-04-13 13:36:36.0

Pushed: 2018-04-20 13:35:11.0

Homepage:

Size: 377

Language: Python

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

spyder-unittest

Copyright © 2014?2018 Spyder Project Contributors

license pypi version conda version download count Join the chat at https://gitter.im/spyder-ide/public

Build Status Build status CircleCI Coverage Status

Screenshot of spyder-unittest plugin


Important Announcement: Spyder needs your support!

Since mid-November 2017, Anaconda, Inc has stopped funding Spyder development, after doing so for the past 18 months. Therefore, without additional funds, development will shift to maintaining Spyder 3 at a slower pace than before, while working toward an eventual Spyder 4 feature release sometime in the future. At the moment we do not plan to spend much effort on the development of Spyder plugins, such as this one.

However, with your contribution of effort and funding, we will be able to both continue to maintain Spyder 3 at a faster pace, and fund development of new features for Spyder 4 and its plugins (including this plugin and the spyder-notebook plugin) at a greatly accelerated rate.

There are many ways to help with development, many of which don't require any programming, and if you're able to make a financial contribution to help support your favorite community IDE, you can donate through our OpenCollective.

We appreciate all the help you can provide us and can't thank you enough for supporting the work of the Spyder devs and Spyder development! To learn more about the current situation and our future plans, please read this page.


Description

Spyder-unittest is a plugin for Spyder that integrates popular unit test frameworks. It allows you to run tests and view the results.

The plugin supports the unittest framework in the Python standard library and the py.test and nose testing frameworks. Support for py.test is most complete at the moment.

Installation

The unittest plugin is available in the spyder-ide channel in Anaconda and in PyPI, so it can be installed with the following commands:

All dependencies will be automatically installed. You have to restart Spyder before you can use the plugin.

Usage

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. The Unit testing window pane (displayed at the top of this file) will pop up with the results. If you are using py.test, 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 frameworks, click Configure in the Options menu (cogwheel icon), which is located in the upper right corner of the Unit testing pane.

Feedback

Bug reports, feature requests and other ideas are more than welcome on the issue tracker. You may use http://groups.google.com/group/spyderlib for general discussion.

Development

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 and running pip install ., possibly with the --editable flag.

The plugin has the following dependencies:

In order to run the tests distributed with this plugin, you need nose, py.test and pytest-qt. If you use Python 2, you also need mock.

You are very welcome to submit code contributations 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.

Contributing

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.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.