Metadata-Version: 2.5
Name: pipe-ping
Version: 0.1.0
Summary: A pluggable CI/CD monitor that notifies you when pipelines succeed, fail or are cancelled
Project-URL: Homepage, https://github.com/EJEmmett/pipe-ping
Project-URL: Documentation, https://ejemmett.github.io/pipe-ping/
Project-URL: Issues, https://github.com/EJEmmett/pipe-ping/issues
Project-URL: Releases, https://github.com/EJEmmett/pipe-ping/releases
Author-email: Edward Emmett <edemms12@gmail.com>
License-Expression: MIT
License-File: LICENSE
Keywords: cd,ci,github-actions,monitoring,notifications,pipelines
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Framework :: AsyncIO
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: System :: Monitoring
Requires-Python: >=3.13
Requires-Dist: aiohttp>=3.14.3
Requires-Dist: aiosqlite>=0.22
Requires-Dist: desktop-notifier>=6.2
Requires-Dist: platformdirs>=4.10.0
Requires-Dist: pydantic-settings>=2.7
Requires-Dist: pydantic>=2.10
Requires-Dist: python-json-logger>=4.1.0
Requires-Dist: rich>=15.0.0
Requires-Dist: typer>=0.15
Description-Content-Type: text/markdown

# Pipe-Ping

Pipe-Ping monitors your CI/CD pipelines and notifies you when they succeed,
fail or are cancelled.

- Supports GitHub Actions, including GitHub Enterprise Server.
- Notifies you in the terminal and with desktop notifications on Linux, macOS
  and Windows.
- Reports only status changes. Pipelines that finish while Pipe-Ping is stopped
  are reported when it next starts.
- Runs in the background as a systemd service, launchd agent or Windows
  scheduled task.
- Supports plugins for other CI/CD services, notification channels and storage
  backends.

**Documentation:** <https://ejemmett.github.io/pipe-ping/>

## Quick start

Pipe-Ping requires Python 3.13 or later and a GitHub token with read access to
Actions on the repositories you want to monitor.

Install Pipe-Ping with [uv](https://docs.astral.sh/uv/) or
[pipx](https://pipx.pypa.io/):

```bash
uv tool install pipe-ping
```

Print the location of the config file:

```bash
pipe-ping config-path
```

Create the file and add your token and the repositories to monitor:

```env
PIPE_PING_GITHUB__TOKEN=github_pat_...
PIPE_PING_GITHUB__REPOS='["owner/repo", "owner/other-repo"]'
```

Then start Pipe-Ping:

```bash
pipe-ping daemon
```

## Learn more

- [Getting started](https://ejemmett.github.io/pipe-ping/getting-started/)
- [Configuration](https://ejemmett.github.io/pipe-ping/configuration/)
- [Notifications](https://ejemmett.github.io/pipe-ping/notifications/)
- [Running in the background](https://ejemmett.github.io/pipe-ping/running-in-the-background/)
- [Writing a plugin](https://ejemmett.github.io/pipe-ping/plugins/)
- [Development](https://ejemmett.github.io/pipe-ping/development/)

## License

MIT
