Metadata-Version: 2.1
Name: ays_agent
Version: 1.0
Summary: @ys Agent Sensor
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click>=7.1.2
Requires-Dist: fastapi>=0.109.1
Requires-Dist: fastapi-utils>=0.2.1
Requires-Dist: psutil>=5.9.5
Requires-Dist: PyYaml>=6.0
Requires-Dist: requests>=2.31.0
Requires-Dist: rich>=13.7.0
Requires-Dist: typer>=0.9.0
Requires-Dist: urllib3<2,>=1.26.18
Requires-Dist: uvicorn>=0.18.3

# ays-agent

The At Your Service Agent Sensor is a Python app that allows you to monitor a system.

The agent provides a few mechanisms to report status to @ys. You can:

- Use the built-in resource usage agent. This will send CPU, HDD, RAM, and/or network usage to @ys.
- Call the agent as a one-shot script with a value or status.
- Execute a program, on a specified interval, and report the values it produces.

This agent integrates directly with the [Agent Sensor Service](https://api.bithead.io:8443/help/library/what-is-an-agent/). Therefore, the property values provided to the CLI app are the same as those described in the documentation. For example, the alerting levels (`critical` ... `warning`), status states (`critical` ... `healthy`), etc. use the same parameter values.

## Installation

Install using `pip` (requires Python v3.8+).

```bash
pip install ays-agent
```

**TODO:** Windows self-contained installer

## What Next?

Please refer to

- [API documentation](docs/api.md)
- [Usage examples](docs/usage.md)
