Skip to content

Commit

Permalink
Aqueduct tweaks (#9)
Browse files Browse the repository at this point in the history
* ENH: Update to add link to live QE docs

* ENH: Update asset_identifier_format default to sid

asset_identifier_format values of `symbol` and `fsym_region_id` are _only valid_ for US_EQUITIES domains.

`symbol` will cause a `TypeError: Expected unicode, got <type 'str'>` exception, while `fsym_region_id` will cause `IndexError: cannot do a non-empty take from an empty axes.`
  • Loading branch information
chrismyles4 authored Oct 30, 2019
1 parent 1801259 commit b0d3683
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ are several ways to use it:
Usage
~~~~~

Note: Fuller documentation will be coming soon.
Note: Fuller documentation is available at https://factset.quantopian.com/docs/user-guide/tools/aqueduct.

To use ``AqueductClient``, create an instance. In this case, we are loading credentials from disk or environment variable.

Expand All @@ -46,7 +46,7 @@ To use ``AqueductClient``, create an instance. In this case, we are loading cred
client = create_client()
To run a new pipeline execution, use ``submit_pipeline_execution``. Required parameters are ``code`` (string), ``start_date`` and ``end_date`` (date-like strings, dates, or Pandas timestamps). Optional parameters are ``name`` (string), ``params`` (a dict of parameters to pass to your pipeline), and ``asset_identifier_format`` (which can be "symbol" (default), "sid", and "fsym_region_id"). ``submit_pipeline_execution`` returns an id, which you can pass to ``get_pipeline_execution`` to monitor this pipeline's execution status.
To run a new pipeline execution, use ``submit_pipeline_execution``. Required parameters are ``code`` (string), ``start_date`` and ``end_date`` (date-like strings, dates, or Pandas timestamps). Optional parameters are ``name`` (string), ``params`` (a dict of parameters to pass to your pipeline), and ``asset_identifier_format`` (which can be "symbol", "sid", and "fsym_region_id"). ``submit_pipeline_execution`` returns an id, which you can pass to ``get_pipeline_execution`` to monitor this pipeline's execution status.


``get_all_pipeline_executions`` and ``get_pipeline_execution(id)`` let you load existing pipelines. Each pipeline has a ``status`` field, which can be ``IN-PROGRESS``, ``SUCCESS``, or ``FAILED``.
Expand Down
4 changes: 2 additions & 2 deletions aqueduct_client/aqueduct_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ def submit_pipeline_execution(self,
end_date,
name=None,
params=None,
asset_identifier_format="symbol"):
asset_identifier_format="sid"):
"""
Creates and queues a new pipeline execution.
Expand All @@ -153,7 +153,7 @@ def submit_pipeline_execution(self,
params : dict, optional
Input arguments for make_pipeline method defined in code.
asset_identifier_format : str (optional)
The type of identifier used to uniquely identify a security.
The type of identifier used to identify a security.
Valid options are "symbol", "sid", or "fsym_region_id".
Returns
Expand Down

0 comments on commit b0d3683

Please sign in to comment.