# Green: A Clean, Colorful, and Fast Python Test Runner

This repository profile is provided by osrepos.com, an open source repository discovery platform.

Source: osrepos.com
Repository profile: https://osrepos.com/repo/cleancut-green
Generated for open source discovery and AI-assisted research.

Green is an innovative Python test runner designed for clarity, speed, and visual appeal. It provides a clean, colorful, and fast way to execute `unittest` based tests, enhancing the developer experience with detailed, aligned output and parallel execution.

GitHub: https://github.com/CleanCut/green
OSRepos URL: https://osrepos.com/repo/cleancut-green

## Summary

Green is an innovative Python test runner designed for clarity, speed, and visual appeal. It provides a clean, colorful, and fast way to execute `unittest` based tests, enhancing the developer experience with detailed, aligned output and parallel execution.

## Topics

- green
- python
- test-automation
- test-driven-development
- test-runner
- testing
- unittest
- Python Testing

## Repository Information

Last analyzed by OSRepos: Tue Aug 04 2026 16:29:35 GMT+0100 (Western European Summer Time)
Detail views: 0
GitHub clicks: 0

## Safety Notice

OSRepos shares public repositories for knowledge and discovery only. Review source code, dependencies, licenses, and security implications before running or installing anything.

## Content

## Introduction

Green is a modern, feature-rich Python test runner that brings a fresh perspective to `unittest` execution. Developed by CleanCut, Green emphasizes clean, colorful, and fast test results, making the test-driven development cycle more intuitive and enjoyable. It supports parallel test execution, offers multiple verbosity levels, and integrates with popular tools like `coverage` and Django.

## Installation

To get started with Green, simply install it using pip:

bash
pip3 install green


To upgrade an existing installation:

bash
pip3 install --upgrade green


## Examples

Once installed, running your tests with Green is straightforward. Here are a few common ways to use it:

**Run from inside your code directory:**
bash
green


**Run from outside your code directory, specifying the target:**
bash
green code_directory


**Run a specific test file:**
bash
green test_stuff.py


**Run a specific test within a package:**
bash
green package.test.test_module.TestClass.test_function


For more options and detailed usage, you can always run `green --help` or refer to the [complete command-line options](https://github.com/CleanCut/green/blob/main/cli-options.txt){target="_blank"}.

## Why Use Green

Green stands out with a compelling set of features designed to improve your testing workflow:

*   **Clean and Colorful Output**: Say goodbye to gray, cluttered terminal output. Green provides vertically aligned, low-redundancy results with vibrant colors, making it easy to spot successes and failures.
*   **Fast Execution**: Tests run in independent processes, utilizing multiple processors by default for significantly faster execution times.
*   **Powerful and Traditional**: It leverages the standard `unittest` classes and methods while offering multi-target auto-discovery.
*   **Descriptive Verbosity**: Choose from various verbosity levels, from simple dots to full docstring output, to get the right amount of detail.
*   **Convenient Integrations**: Includes Bash and ZSH completion for options and test targets, built-in `coverage` integration, and support for `setup.py` commands and Django.
*   **Modern and Portable**: Supports Python 3.8+ and PyPy, and is compatible with macOS, Linux, BSDs, and Windows.

Green's origin story highlights a journey to create a test runner that prioritizes developer experience, addressing shortcomings found in other tools regarding output clarity, Python 3 compatibility, and maintainability. It was born from a desire for a truly "Red/Green/Refactor" experience, emphasizing the visual feedback crucial for TDD.

## Links

Explore Green further through these resources:

*   **GitHub Repository**: [CleanCut/green](https://github.com/CleanCut/green){target="_blank"}
*   **Discussions**: [Open a discussion](https://github.com/CleanCut/green/discussions){target="_blank"}
*   **Issue Tracker**: [Submit an issue](https://github.com/CleanCut/green/issues/new){target="_blank"}
*   **Pull Requests**: [Submit a pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/){target="_blank"}
*   **Training Course**: [Python Testing with Green on Udemy](https://www.udemy.com/python-testing-with-green/?couponCode=GREEN_GITHUB){target="_blank"}