|message type||trigger event||message payload||examples|
|*.file.#||when any file is uploaded|
when any file of the given MIME type is uploaded
(this is just a more specific matching)
|*.dataset.file.added||when a file is added to a dataset||clowder.dataset.file.added|
|*.dataset.file.removed||when a file is removed from a dataset||clowder.dataset.file.removed|
|*.metadata.added||when metadata is added to a file or dataset||clowder.metadata.added|
|*.metadata.removed||when metadata is removed from a file or dataset||clowder.metadata.removed|
Typical extractor structure
cd /etc/init for x in clowder-*.conf; do start `basename $x .conf` done
Converting from pyClowder to pyClowder2
- If there are parameters in config.py that don't use the default values in the link under Key differences, they should be listed as command line parameters in your new extractor class __init__ or simply coded into the script. It's possible to make the parameters read from environment variables as well.
- https://github.com/terraref/extractors-stereo-rgb/pull/3/files - in this example,
- ...and below the self.parser.add_argument the input values can be adjusted before assinging to self.args (e.g. cast a string to an int):
- Add the messageType from config.py into extractor_info.json
- Move your extractor python functions into a new Extractor subclass
- https://github.com/terraref/extractors-stereo-rgb/pull/3/files#diff-924a575b0595fcd52d5531433471b109R23 Here a new extractor class called StereoBin2JpgTiff is created.
- main() -> __init__(self) (but only for handling inputs)
- check_message() and process_message() must be named as such now, and receive explicit inputs:
- self, connector, host, secret_key, resource, parameters
- typically, old references to parameters['xyz'] can be replaced either with resource['xyz'] or with secret_key, host, etc.
- if you aren't sure when writing, you can use print(resource) in your extractor testing to see what fields are included.
- Modify old extractor.method() to use the new pyclowder.files.method() or pyclowder.datasets.method()
- more to come
- finally, the call to main() is replaced with a simple instantiation of your extractor class.
- extractor = StereoBin2JpgTiff(); extractor.start()
Registering an Extractor
If you create an extractor and want to register it for widespread use Clowder has a catalog of extractors. To let the community know about your extractor you may submit it to the catalog (registration required) for publication alongside the extractors created by the Clowder developers, and other Clowder community developers.
- If you haven't registered you may do so at the registration page (to be linked soon). Registration will need to be approved, so this will not be an instantaneous process. Once approved you will be able to sign in, and submit extractors.
- Sign in to the catalog at the sign in page.
- Click the Contribute link at the top, or visit the contribution page.
- Paste your extractor info into the text box on the contribution page. The extractor info has all the information that we use in the catalog, so having a fully detailed extractor info is important for the catalog.
- Select Extractor from the radio buttons under the text box (Converter is for converting one file type to another, and there may be more options added for other tools at a later date).
- Submit the extractor.
- On the home page you may not see your extractor immediately. Once submitted it must be approved by one of the Clowder development team to show up on the home page. As long as your links to where to get the extractor check out you will likely be approved, and if there are correctable issues we may contact you.