https://github.com/citrineinformatics/citrine-python-converter-template
Converter template for python
https://github.com/citrineinformatics/citrine-python-converter-template
Last synced: 20 days ago
JSON representation
Converter template for python
- Host: GitHub
- URL: https://github.com/citrineinformatics/citrine-python-converter-template
- Owner: CitrineInformatics
- License: apache-2.0
- Created: 2017-03-14T13:31:37.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-09-07T22:12:52.000Z (almost 9 years ago)
- Last Synced: 2025-03-12T22:37:47.916Z (over 1 year ago)
- Language: Python
- Size: 13.7 KB
- Stars: 0
- Watchers: 32
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# citrine-python-converter-template
This is a template for defining Citrination-compatible converters in python.
These converters can be hosted on Citrination as an "ingester" or run through the [pif-ingestor](https://github.com/CitrineInformatics/pif-ingestor) CLI driver.
This is accomplished by defining an extension with a `convert` method is loaded and executed by drivers on Citrination or locally.
## Usage
This converter is in the form of a dummy example.
To use it, you'll need to edit some of the files.
There are no templating magicks (at this point).
Let's just go through the files:
### `super_fun_converter`
This directory name is the name of the converter package.
Its good practice to pick a descriptive name, but anything will do.
This should also be the name of your repository.
It is helpful (but not strictly required) if the name doesn't conflict with any existing packages on [PyPI](https://pypi.python.org/pypi).
This directory contains the converter
### `my_module.py`
This is a example module that contains a convert method.
You can change the name of the module by renaming the file.
Just be sure it contains a `convert` method that takes keyword arguments.
### `description.yaml`
This file contains a description of the converter that is used when constructing a UI for it.
The main block is a list of arguments, giving their name and type along with a description of the argument
and whether it is required or optional.
The example file contains additional information about specifying types.
### `setup.py`
This file describes your converter package.
Change the `name` to whatever you renamed `super_fun_converter` to above.
Also, change the `url` to point to your repository or website.
The `author` and `author_email` fields are optional, but suggested.
`install_requires` should list the external packages your converter uses without version numbers.
Finally, change the `super_fun = ...` line in `entry_points` to name your converter and point to its location.
For example, if you wanted to call the converter `qbox` and it was located in the `qbox_converter` module of `hutch_qbox_converter`
then `entry_points` would read:
```
entry_points={
'citrine.dice.converter': [
'qbox = hutch_qbox_converter.qbox_converter',
],
}
```
### `requirements.txt`
This file lists all of the python packages needed to run the converter with exact version numbers.
They are automatically installed.
## `convert()` method
what we've just done is define an `extension` that can be used in Citrination's data ingest pipeline
and [command line ingestor](https://github.com/CitrineInformatics/pif-ingestor).
The extension is used by calling a method called `convert` with [keyword arguments](https://docs.python.org/3.6/glossary.html#term-argument).
There will always be a keyword argument `files` that is a list of strings.
These are the files that are to be converted into a [PIF](http://citrineinformatics.github.io/pif-documentation/).
`convert` should return either a PIF or a list of PIFs.