Get started with pyFF

The simplest way to get started with pyFF is to run a docker image. After you've got the basic example up and running you may wish to modify it to include remote metadata feeds. Simply modify your mdx.fd file (it doesn't have to be called this - any filename will do) to have the following load section:

- when update:
    - load:
       - http://mds.edugain.org
    - break

This would cause the pyFF instance to load eduGAIN metadata. You can combine any number of local and remote metadata sources - a local source is anything that looks like a local directory. You can (and are encouraged to) verify and post-process metadata using the following syntax:

- fixer
   ... 
- load
   - <URL> verify <fingerprint> via fixer

The 'fixer' pipeline (which can be named anything of course) can be used to post-process metadata, eg to remove known broken metadata components. The is the SHA1 fingerprint of the certificate used to sign the remote metadata. There are many more options and possibilities and if that isn't enough you can write plugins in python. Look at the examples in the official documentation for more ideas.