mirrors/pferd
1
0
Fork 0
mirror of https://github.com/Garmelon/PFERD.git synced 2025-11-04 14:42:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fix example config link in README

Browse Source
This commit is contained in:
I-Al-Istannen
2020-05-15 11:02:45 +02:00
parent 36c8785f15
commit e8ddb0ca04
1 changed files with 2 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@@ -25,7 +25,7 @@ $ cd Vorlesungen
$ python3 -m venv . $ python3 -m venv .
$ . bin/activate $ . bin/activate
$ pip install git+https://github.com/Garmelon/PFERD@rewrite $ pip install git+https://github.com/Garmelon/PFERD@rewrite
$ curl -O https://raw.githubusercontent.com/Garmelon/PFERD/master/example_config.py $ curl -O https://raw.githubusercontent.com/Garmelon/PFERD/rewrite/example_config.py
$ python3 example_config.py $ python3 example_config.py
$ deactivate $ deactivate
``` ```
@@ -38,14 +38,13 @@ $ python3 example_config.py
$ deactivate $ deactivate
``` ```
## Usage ## Usage
A PFERD config is a normal python file that starts multiple *synchronizers* A PFERD config is a normal python file that starts multiple *synchronizers*
which do all the heavy lifting. While you can create and wire them up manually, which do all the heavy lifting. While you can create and wire them up manually,
you are encouraged to use the helper methods provided in `PFERD.Pferd`. you are encouraged to use the helper methods provided in `PFERD.Pferd`.
The synchronizers take some input arguments specific to their sercice and a The synchronizers take some input arguments specific to their service and a
*transformer*. The transformer receives the computed path of an element in *transformer*. The transformer receives the computed path of an element in
ILIAS and can return either an output path (so you can rename files or move ILIAS and can return either an output path (so you can rename files or move
them around as you wish) or `None` if you do not want to save the given file. them around as you wish) or `None` if you do not want to save the given file.