Module pyfx.api

Interacting with a Pricefx platform using a high-level API.

The purpose of this module is provide a high-level API to interact with the platform, through the JobContext, an interface abstracting away the specificities about the context of the execution of a python job.

The main entrypoint when running a python script as part of a logic is obtaining the current JobContext using get_context(). This method will return the context associated with the job on the Pricefx partition.

Pyfx can also be used outside of a Pricefx logic, but in this case there will be no associated JobContext object. Instead, one can use the class method Instance.connect() to manually connect to a Pricefx instance and use the returned Instance object methods to navigate the partition objects.

Sub-modules

pyfx.api.avro

Utility functions to convert pandas DataFrames to avro.

pyfx.api.domain

High-level API for Pyfx domain objects …

pyfx.api.jobcontext

This module define the job context API …