Metadata-Version: 2.0
Name: datadog-checks-base
Version: 1.2.1
Summary: The Datadog Check Toolkit
Home-page: https://github.com/DataDog/datadog-agent-tk
Author: Datadog
Author-email: packages@datadoghq.com
License: New BSD
Keywords: datadog agent checks
Platform: UNKNOWN
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
Requires-Dist: prometheus-client (==0.1.0)
Requires-Dist: requests (==2.18.4)
Requires-Dist: protobuf (==3.5.1)

# Datadog Checks Base

## Overview

This package provides the Python bits needed by the [Datadog Agent](https://github.com/DataDog/datadog-agent)
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.

## Installation

Checks from [integrations-core](https://github.com/DataDog/integrations-core) already
use the toolkit in a transparent way when you run the tests with Tox but you can
install the toolkit locally and play with it:
```
pip install git+https://github.com/DataDog/datadog-agent-tk.git
```

## 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](http://tox.readthedocs.io/en/latest/install.html) and just run:
```
tox
```

## Troubleshooting
Need help? Contact [Datadog Support](http://docs.datadoghq.com/help/).

## Further Reading
Learn more about infrastructure monitoring and all our integrations on [our blog](https://www.datadoghq.com/blog/)


