Skip to content

Commit 35520d0

Browse files
author
Jean Bredeche
authored
Merge pull request #10 from jimportico/readme-edits
Readme edits
2 parents d5764f1 + d39db7c commit 35520d0

File tree

3 files changed

+674
-2
lines changed

3 files changed

+674
-2
lines changed

README.rst

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,12 @@ are several ways to use it:
2727
2828
[default]
2929
API_KEY = your_api_key
30+
31+
Users with Windows can follow the steps below in the Command Prompt:
32+
a) cd %UserProfile%
33+
b) mkdir .quantopian
34+
c) cd .quantopian
35+
d) echo [default] >> credentials && echo API_KEY = 'enter your api key here inside single quotes' >> credentials
3036

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

@@ -43,8 +49,10 @@ To use ``AqueductClient``, create an instance. In this case, we are loading cred
4349
.. code-block:: python
4450
4551
from aqueduct_client import create_client
46-
47-
client = create_client()
52+
from aqueduct_client.utils import load_api_key
53+
54+
API_KEY = load_api_key()
55+
client = create_client(API_KEY)
4856
4957
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.
5058

0 commit comments

Comments
 (0)