{"id":13409731,"url":"https://github.com/quant-aq/py-quantaq","last_synced_at":"2025-12-24T20:24:20.068Z","repository":{"id":35854950,"uuid":"173780695","full_name":"quant-aq/py-quantaq","owner":"quant-aq","description":"A python wrapper for the QuantAQ RESTful API","archived":false,"fork":false,"pushed_at":"2023-11-28T19:12:34.000Z","size":6518,"stargazers_count":8,"open_issues_count":3,"forks_count":2,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-05-16T11:14:21.783Z","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/quant-aq.png","metadata":{"files":{"readme":"README.md","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,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-03-04T16:26:36.000Z","updated_at":"2024-07-30T22:51:29.149Z","dependencies_parsed_at":"2024-07-30T23:09:00.586Z","dependency_job_id":null,"html_url":"https://github.com/quant-aq/py-quantaq","commit_stats":{"total_commits":39,"total_committers":2,"mean_commits":19.5,"dds":"0.46153846153846156","last_synced_commit":"8fd9bf2f02549d0c62e18c4721d3156975fa0d58"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quant-aq%2Fpy-quantaq","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quant-aq%2Fpy-quantaq/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quant-aq%2Fpy-quantaq/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quant-aq%2Fpy-quantaq/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/quant-aq","download_url":"https://codeload.github.com/quant-aq/py-quantaq/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243600486,"owners_count":20317281,"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-07-30T20:01:03.052Z","updated_at":"2025-12-24T20:24:20.063Z","avatar_url":"https://github.com/quant-aq.png","language":"Python","funding_links":[],"categories":["Software Libraries"],"sub_categories":[],"readme":"[![PyPI version](https://badge.fury.io/py/py-quantaq.svg)](https://badge.fury.io/py/py-quantaq)\n![run and build](https://github.com/quant-aq/py-quantaq/workflows/run%20and%20build/badge.svg)\n[![codecov](https://codecov.io/gh/quant-aq/py-quantaq/branch/master/graph/badge.svg)](https://codecov.io/gh/quant-aq/py-quantaq)\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n\n# py-quantaq\nA python wrapper for the QuantAQ RESTful API\n\n## Installation\n\nInstall directly from PyPI:\n\n```sh\n$ pip install -U py-quantaq\n```\n\nOr, install the library directly from GitHub:\n\n```bash\n$ pip install git+https://github.com/quant-aq/py-quantaq.git\n```\n\nYou can also install a pre-release from PyPi:\n\n```bash\n$ pip install py-quantaq --pre\n```\n\n## Docs\n\nDocumentation is in progress, but can be found [here](https://quant-aq.github.io/py-quantaq).\n\n## Authentication\n\nTo use the API, you must first have an API key. You can obtain an API key from the [user dashboard][1]. Once you create a new API key, make sure to keep it secret! The easiest way to do this is to save your key as an environment variable. This process is unique to each OS, but many tutorials exist online. For Mac, do the following:\n\nUsing your editor of choice, open up your `.bash_profile`:\n```bash\n# open up your bash profile\n$ nano ~/.bash_profile\n```\n\nNext, save the API key as an environment variable:\n```bash\n# add a line with your API Key\nexport QUANTAQ_APIKEY=\u003cyour-api-key-goes-here\u003e\n```\n\nFinally, source your `.bash_profile`:\n\n```sh\n$ source ~/.bash_profile\n```\n\nNow, you shouldn't ever have to touch this again or remember the key!\n\n## Tests\n\nTo run the unittests:\n\n```sh\n$ poetry run pytest tests\n```\n\nor, with coverage\n\n```sh\n$ poetry run pytest tests --cov=quantaq --cov-report term-missing -s\n```\n\nTests are automagically run via github actions on each build. Results and coverage are tracked via Code Coverage which can be viewed by clicking on the badge above.\n\n\n[1]: https://www.quant-aq.com/api-keys\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquant-aq%2Fpy-quantaq","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fquant-aq%2Fpy-quantaq","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquant-aq%2Fpy-quantaq/lists"}