Module for creating simple scripts reacting to fedmsg messages
Project description
fedwatch
========
Library for watching fedmsg messages and running arbitrary scripts in a nice way
Think of fedwatch as simple converter from fedmsg json messages into shell
arguments for scripts.
Dependencies
============
* fedmsg (duh!)
* python-dpath (https://github.com/akesterson/dpath-python)
Usage
=====
To use fedwatch you will need to create a configuration file (by default read
from /etc/fedwatch.conf) and scripts that are to be run when messages of
interest arrive (by default /etc/fedwatch.d).
When interesting message arrives, fedmsg converts json data into arguments for
shell scripts and runs each script in <em>script-dir</em> based on
configuration. First argument is always topic so that scripts can handle
different topics.
Real life example of configuration file:
{
"org.fedoraproject.prod.git.receive": {
"args": [
"msg/commit/username",
"msg/commit/repo",
"msg/commit/branch",
"msg/commit/rev",
"msg/commit/summary"
]
}
}
Above configuration means fedwatch will be waiting for <em>git.receive</em>
topic and will pass 6 arguments to any scripts in <em>script-dir</em>:
1. org.fedoraproject.prod.git.receive (topic)
2. FAS username of commiter
3. repository (package) name
4. branch name
5. revision (SHA hash of commit)
6. commit summary (1st line of git commit)
To see list of possible topics and data included in them see
http://fedmsg.readthedocs.org/en/latest/topics/
========
Library for watching fedmsg messages and running arbitrary scripts in a nice way
Think of fedwatch as simple converter from fedmsg json messages into shell
arguments for scripts.
Dependencies
============
* fedmsg (duh!)
* python-dpath (https://github.com/akesterson/dpath-python)
Usage
=====
To use fedwatch you will need to create a configuration file (by default read
from /etc/fedwatch.conf) and scripts that are to be run when messages of
interest arrive (by default /etc/fedwatch.d).
When interesting message arrives, fedmsg converts json data into arguments for
shell scripts and runs each script in <em>script-dir</em> based on
configuration. First argument is always topic so that scripts can handle
different topics.
Real life example of configuration file:
{
"org.fedoraproject.prod.git.receive": {
"args": [
"msg/commit/username",
"msg/commit/repo",
"msg/commit/branch",
"msg/commit/rev",
"msg/commit/summary"
]
}
}
Above configuration means fedwatch will be waiting for <em>git.receive</em>
topic and will pass 6 arguments to any scripts in <em>script-dir</em>:
1. org.fedoraproject.prod.git.receive (topic)
2. FAS username of commiter
3. repository (package) name
4. branch name
5. revision (SHA hash of commit)
6. commit summary (1st line of git commit)
To see list of possible topics and data included in them see
http://fedmsg.readthedocs.org/en/latest/topics/
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
fedwatch-0.5.tar.gz
(14.6 kB
view details)
File details
Details for the file fedwatch-0.5.tar.gz
.
File metadata
- Download URL: fedwatch-0.5.tar.gz
- Upload date:
- Size: 14.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a81102737537c20b35b2ef1514971b6d6cb5d9442acabdd310a99469d6494643 |
|
MD5 | 8cff40812ee9fc7fc552fe5306c5a0ee |
|
BLAKE2b-256 | b0b17a6214683b09c9a0a6b879fbf4049b09239cc3eec02bcd5556c92997caa8 |