{"id":19720851,"url":"https://github.com/quantopian/aqueduct-client","last_synced_at":"2025-04-29T21:31:06.405Z","repository":{"id":57411259,"uuid":"186035041","full_name":"quantopian/aqueduct-client","owner":"quantopian","description":"Python wrapper for Quantopian's Aqueduct API","archived":false,"fork":false,"pushed_at":"2023-04-07T02:37:25.000Z","size":61,"stargazers_count":2,"open_issues_count":0,"forks_count":15,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-04-15T07:42:44.855Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/quantopian.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2019-05-10T18:14:01.000Z","updated_at":"2021-02-18T06:38:23.000Z","dependencies_parsed_at":"2022-09-09T22:23:14.005Z","dependency_job_id":"144633b1-a23b-4c98-b9e1-16e3dcb026bc","html_url":"https://github.com/quantopian/aqueduct-client","commit_stats":{"total_commits":27,"total_committers":5,"mean_commits":5.4,"dds":0.5925925925925926,"last_synced_commit":"35520d0fa4a57ff043816758df2f8a97d15a4a41"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quantopian%2Faqueduct-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quantopian%2Faqueduct-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quantopian%2Faqueduct-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quantopian%2Faqueduct-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/quantopian","download_url":"https://codeload.github.com/quantopian/aqueduct-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251585771,"owners_count":21613277,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-11T23:12:43.389Z","updated_at":"2025-04-29T21:31:01.391Z","avatar_url":"https://github.com/quantopian.png","language":"Python","readme":"``AqueductClient``\n==================\n\n``AqueductClient`` is a simple Python wrapper around Quantopian's Aqueduct API.\nIt lets you easily create Pipeline executions and load their results.\n\n``AqueductClient`` supports Python 2.7 and Python 3.4+.\n\n\nInstallation\n~~~~~~~~~~~~\n\n.. code-block:: shell\n\n   $ pip install aqueduct-client\n\n\nConfiguration\n~~~~~~~~~~~~~\n\nTo use ``AqueductClient``, you need a Quantopian API Key.  Once you have it, there\nare several ways to use it:\n\n1) Use a credentials file:  create ``~/.quantopian/credentials`` (Linux or OS X) or ``%UserProfile%\\.quantopian\\credentials`` (Windows) and put the following in it:\n\n  .. code-block:: shell\n\n      [default]\n      API_KEY = your_api_key\n      \n  Users with Windows can follow the steps below in the Command Prompt:\n   a) cd %UserProfile%\n   b) mkdir .quantopian\n   c) cd .quantopian\n   d) echo [default] \u003e\u003e credentials \u0026\u0026 echo API_KEY = 'enter your api key here inside single quotes' \u003e\u003e credentials\n\n2) Use an environment variable: set ``QUANTOPIAN_API_KEY`` to your API key.\n\n3) Pass your API key directly into the ``create_client`` method (see below) using the ``api_key`` kwarg.\n\n\nUsage\n~~~~~\n\nNote: Fuller documentation is available at https://factset.quantopian.com/docs/user-guide/tools/aqueduct.\n\nTo use ``AqueductClient``, create an instance. In this case, we are loading credentials from disk or environment variable.\n\n.. code-block:: python\n\n  from aqueduct_client import create_client\n  from aqueduct_client.utils import load_api_key\n  \n  API_KEY = load_api_key()\n  client = create_client(API_KEY)\n\nTo 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.\n\n\n``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``.\n\nFor a successful pipeline, ``get_pipeline_results_dataframe(id)`` loads that pipeline's results into a pandas DataFrame.  For a failed pipeline, ``get_pipeline_execution_error(id)`` shows you the information about the error.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquantopian%2Faqueduct-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fquantopian%2Faqueduct-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquantopian%2Faqueduct-client/lists"}