Document in the README how to run the project

Signed-off-by: Pierre-Yves Chibon <pingou@pingoured.fr>
This commit is contained in:
Pierre-Yves Chibon 2020-04-29 18:03:21 +02:00
parent 942c0e76f3
commit e9c8be8d9b

View file

@ -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