Metadata-Version: 2.1
Name: ruthie
Version: 0.1.3
Summary: Run Unit Tests Harmoniously Incredibly Easy
Home-page: https://github.com/bitbar/ruthie
License: ISC
Keywords: ruthie,unittests,tests,runner,parallel
Author: Marek Sierociński
Author-email: marek.sierocinski@smartbear.com
Requires-Python: >=3.6.1,<4.0.0
Classifier: License :: OSI Approved
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Software Development :: Testing :: Unit
Requires-Dist: docopt (==0.6.2)
Requires-Dist: toml (>=0.9)
Requires-Dist: xmlrunner (>=1.7.7,<1.8.0)
Project-URL: Repository, https://github.com/bitbar/ruthie
Description-Content-Type: text/markdown

# Ruthie

[![Current Release](https://img.shields.io/github/release/bitbar/ruthie.svg)](releases)
[![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg)](LICENSE.md)

<div align="center">
	<img height="256" src=".static/logo.png" alt="Ruthie Logo">
</div>

Ruthie is the Unittests runner, and it's an acronym from "Run Unit Tests Harmoniously Incredibly Easy". 

## Installation

```sh
pip install -U ruthie
```

Check if it works:

```sh
ruthie --version
> 0.1.2
```

## Usage

Type `ruthie --help` to display available commands and options

### Examples

#### List all test classes in directory "unittests"

```sh
ruthie discover classes unittests
```

Output:

```sh
unittests.admin_panel.users.Add
unittests.admin_panel.users.Edit
unittests.admin_panel.users.Delete
unittests.admin_panel.devices.Add
unittests.admin_panel.devices.Edit
unittests.admin_panel.devices.Delete
unittests.end_user.projects.Add
unittests.end_user.projects.Edit
unittests.end_user.projects.Delete
```

#### List all test classes in directory "unittests" and group them

```sh
ruthie discover classes unittests --group
```

Output:

```sh
  unittests.admin_panel.users
    Add
    Edit
    Delete
  unittests.admin_panel.devices
    Add
    Edit
    Delete
  unittests.end_user.projects
    Add
    Edit
    Delete
```

#### Discover all classes in directory "unittests" and run them in parallel using 10 threads

```sh
ruthie parallel --threads=10 unittests
```

## License

This project is licensed under the ISC License - see the [LICENSE](LICENSE) file for details.

