Skip to content

Commit

Permalink
Merge pull request #10 from jimportico/readme-edits
Browse files Browse the repository at this point in the history
Readme edits
  • Loading branch information
Jean Bredeche authored May 5, 2020
2 parents d5764f1 + d39db7c commit 35520d0
Show file tree
Hide file tree
Showing 3 changed files with 674 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,12 @@ are several ways to use it:
[default]
API_KEY = your_api_key
Users with Windows can follow the steps below in the Command Prompt:
a) cd %UserProfile%
b) mkdir .quantopian
c) cd .quantopian
d) echo [default] >> credentials && echo API_KEY = 'enter your api key here inside single quotes' >> credentials

2) Use an environment variable: set ``QUANTOPIAN_API_KEY`` to your API key.

Expand All @@ -43,8 +49,10 @@ To use ``AqueductClient``, create an instance. In this case, we are loading cred
.. code-block:: python
from aqueduct_client import create_client
client = create_client()
from aqueduct_client.utils import load_api_key
API_KEY = load_api_key()
client = create_client(API_KEY)
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.

Expand Down
Loading

0 comments on commit 35520d0

Please sign in to comment.