Metadata-Version: 2.4
Name: stackstate_checks_base
Version: 6.12.0
Summary: The StackState Check Toolkit
Home-page: https://github.com/StackVista/stackstate-agent-integrations
Author: StackState
Author-email: info@stackstate.com
License: BSD
Keywords: stackstate agent checks
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: System :: Monitoring
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Description-Content-Type: text/markdown
Provides-Extra: deps
Requires-Dist: pyyaml==6.0.2; python_version > "3.0" and extra == "deps"
Requires-Dist: prometheus-client==0.24.1; python_version > "3.0" and extra == "deps"
Requires-Dist: protobuf==6.33.5; python_version > "3.0" and extra == "deps"
Requires-Dist: pywin32==306; (sys_platform == "win32" and python_version > "3.0") and extra == "deps"
Requires-Dist: requests==2.33.0; python_version > "3.0" and extra == "deps"
Requires-Dist: urllib3==2.7.0; extra == "deps"
Requires-Dist: simplejson==3.20.1; extra == "deps"
Requires-Dist: six==1.16.0; extra == "deps"
Requires-Dist: uuid==1.30; extra == "deps"
Requires-Dist: boto3==1.42.54; python_version > "3.0" and extra == "deps"
Requires-Dist: flatten-dict==0.2.0; extra == "deps"
Requires-Dist: Deprecated==1.2.10; extra == "deps"
Requires-Dist: enum34==1.1.10; python_version < "3.0" and extra == "deps"
Requires-Dist: pydantic==2.12.5; extra == "deps"
Requires-Dist: pytz==2021.1; extra == "deps"
Requires-Dist: iso8601==0.1.14; extra == "deps"
Requires-Dist: docker==6.1.3; extra == "deps"
Provides-Extra: json
Requires-Dist: orjson==3.11.7; python_version > "3.0" and extra == "json"
Provides-Extra: kube
Requires-Dist: kubernetes==35.0.0; python_version > "3.0" and extra == "kube"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: provides-extra
Dynamic: summary

# StackState Checks Base

## Overview

This package provides the Python bits needed by the [StackState Agent][1]
to run Agent-based Integrations (also known as _Checks_).

This _Check toolkit_ is used in two scenarios:

 1. When used from within the Python interpreter embedded in the Agent, it
 provides all the base classes and utilities needed by any Check.

 2. When installed in a local environment with a regular Python interpreter, it
 mocks the presence of a running Agent so checks can work in standalone mode,
 mostly useful for testing and development.

## Development

Create a dedicated virtualenv and follow the instructions in this paragraph
to work with the check.

To install the check in dev mode:
```
pip install -e ".[dev]"
```

To build the wheel package:
```
python setup.py bdist_wheel
```

To run the tests, [install tox][3] and just run:
```
tox
```

[1]: https://github.com/StackVista/stackstate-agent
[2]: https://github.com/StackVista/stackstate-agent-integrations
[3]: https://tox.readthedocs.io/en/latest/install.html
