From e9c8be8d9bc6d29517de3c7189c6dbebbc711f36 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Wed, 29 Apr 2020 18:03:21 +0200 Subject: [PATCH] Document in the README how to run the project Signed-off-by: Pierre-Yves Chibon --- README.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.rst b/README.rst index 9946d75..14d5147 100644 --- a/README.rst +++ b/README.rst @@ -5,4 +5,25 @@ This project is basically a small script that runs in a loop to keep locally an up to date mirror of the ansible project hosted on pagure.io +Run this locally +---------------- + +* The ``mirror_from_pagure.py`` script can simply be run manually. You may want + to adjust some of its variable at the top indicating which repo to mirror and + where to store them on disk, but the rest should work out of the box + +* The ``mirror_from_pagure_bus.py`` is a fedora-messaging consumer. + To run it you will have to follow these steps (for dev): + + * Adjust the example configuration file: + :: + + sed -e "s/[0-9a-f]\{8\}-[0-9a-f]\{4\}-[0-9a-f]\{4\}-[0-9a-f]\{4\}-[0-9a-f]\{12\}/$(uuidgen)/g" \ + local_config.toml > my_config.toml + + * Run the consumer: + :: + PYTHONPATH=. fedora-messaging --conf my_config.toml consume + + License: MIT