---
id: pyats-kleenex
version: "26.7"
license: Apache 2.0
license_treatment: permissive
maintenance: active
---

# pyats.kleenex — pyATS Kleenex: Testbed Preparation, Clean & Finalization

License: permissive · Maintenance: active · Downloads: 296.1K/mo

## What it is and what it does

pyATS Kleenex is a sub-component of the pyATS end-to-end testing framework that handles testbed device preparation and cleanup. It provides a standardized interface for developers to write and execute code that interacts with testbed devices, ensuring they are in a known clean state before test execution begins. The package is designed to integrate seamlessly with pyATS's data-driven and reusable testing model, supporting both simple linear workflows and complex asynchronous test suites.

Kleenex abstracts away the complexity of device state management across heterogeneous testbeds, allowing teams to define cleanup and finalization logic once and apply it consistently across test runs. It is part of Cisco's pyATS ecosystem, which emphasizes Agile rapid development and extensibility. The package supports modern Python versions (3.8+) on Linux and macOS, with active maintenance and no known security vulnerabilities.

Use it for:

- Reset testbed devices to a baseline configuration before running automated test suites
- Orchestrate cleanup tasks across multiple devices in parallel as part of test teardown
- Standardize device preparation logic across teams to ensure reproducible test environments
- Integrate device state management into CI/CD pipelines for network and infrastructure testing
- Finalize device state after test execution to prevent test pollution in shared testbeds

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

Standardizes testbed device preparation, cleanup, and finalization workflows within the pyATS testing ecosystem, providing a framework for orchestrating device state management before and after test execution.

Yes, if you are already using pyATS for testing. Kleenex is a focused, actively maintained sub-component that solves a real problem in test automation—reliable device cleanup and preparation. It has no security vulnerabilities, permissive licensing, and broad Python version support. Install friction is moderate due to its eight pyATS dependencies, but these are expected in the pyATS ecosystem. If you are not using pyATS, this package is not useful standalone.

## Install

pip install pyats-kleenex
uv add pyats-kleenex
poetry add pyats-kleenex

## Installing pyats.kleenex

Before you install: Active maintenance with a release within the past week. Medium install friction due to eight runtime dependencies, all within the pyATS ecosystem. Wheels available for Python 3.10–3.14 across macOS and Linux platforms (including musllinux), reducing compilation overhead.

License in practice: Apache 2.0 permissive license allows commercial and private use with minimal restrictions, typical for infrastructure testing tools.

Quickstart:

pip install pyats.kleenex

from pyats.kleenex import Kleenex

kleenex = Kleenex(testbed)
kleenex.clean()

Requires Python 3.8 or later. Depends on eight pyATS sub-packages (aetest, async, datastructures, log, topology, utils) and requests; ensure the full pyATS ecosystem is installed or install pyats as a whole.

Verify before relying:

- Whether Kleenex can be used standalone or requires the full pyATS installation
- Specific device types and platforms supported for cleanup orchestration
- Performance characteristics when managing large testbeds with many devices

## Package facts

- License: Apache 2.0 (permissive)
- Python support: supports_current
- Install friction: medium
- Maintenance: active
- Downloads: 296.1K/month (top 15,000 on PyPI)
- Known vulnerabilities: none known

## Tags

testbed device cleanup, test environment preparation, device state management, pyats testing framework, test orchestration, testbed finalization, device provisioning automation, testbed-automation, network-testing, cisco-pyats

[View on SkillFed](https://skillfed.io/packages/pyats-kleenex) · [View on PyPI](https://pypi.org/project/pyats-kleenex/)