{"id":19179739,"url":"https://github.com/holistics/holistics-python","last_synced_at":"2025-08-04T05:39:06.187Z","repository":{"id":54258231,"uuid":"138029206","full_name":"holistics/holistics-python","owner":"holistics","description":"Python library for Holistics (using Holistics API)","archived":false,"fork":false,"pushed_at":"2021-03-01T04:32:43.000Z","size":124,"stargazers_count":7,"open_issues_count":0,"forks_count":0,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-07-15T18:07:25.215Z","etag":null,"topics":["api","library","python"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/holistics.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}},"created_at":"2018-06-20T12:22:02.000Z","updated_at":"2025-02-15T05:41:46.000Z","dependencies_parsed_at":"2022-08-13T10:10:50.550Z","dependency_job_id":null,"html_url":"https://github.com/holistics/holistics-python","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/holistics/holistics-python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/holistics%2Fholistics-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/holistics%2Fholistics-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/holistics%2Fholistics-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/holistics%2Fholistics-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/holistics","download_url":"https://codeload.github.com/holistics/holistics-python/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/holistics%2Fholistics-python/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268655136,"owners_count":24285128,"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","status":"online","status_checked_at":"2025-08-04T02:00:09.867Z","response_time":79,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["api","library","python"],"created_at":"2024-11-09T10:44:30.561Z","updated_at":"2025-08-04T05:39:06.164Z","avatar_url":"https://github.com/holistics.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Python Library for Holistics API\n\nOur package ([**Holistics Package for Python**](https://github.com/holistics/holistics-python)) allow Python's user export report's data by inputting:\n- Your API-key\n- Report's ID\n- Dictionary of filters applied to that report\n\n\n# **Installation**\nPackage can be installed with `pip`:\n```\npip install holistics\n```\nAlternatively, you can grab the latest source code from GitHub:\n```python\ngit clone git://github.com/holistics/holistics-python.git\ncd holistics-python\npython setup.py install\n```\n\n# **How to export data**\nBeginning by import holistics package\n```python\nfrom holistics import HolisticsAPI\n```  \n\n\nNext, creating an object of HolisticsAPI class with your API-key and Holistics server's url\n```python\nobj = HolisticsAPI(api_key = 'aerg454hoiaKJGlgku', url = 'demo.holistics.io')\n```\n**Args:**\n- `api_key` **(str):** Your account's API-key. \n    - [How to generate API-key](https://docs.holistics.io/api/)\n- `url` **(str) (optional):** URL of your Holistics server \n    - Default value: 'https://secure.holistics.io'\n    \n\nFinally, call export_data function with specific syntax:\n```python\nexport_data (report_id, path, filter_dict, _page_size, _page)\n```\n\nFor example:\n```python\nmy_dataframe = obj.export_data(report_id='123456', path='C:/output.csv', \n                              filter_dict={'date': '2017-04-28', 'vat': 1.1}, \n                              _page_size = 12, _page = 5)\n```\n\n**Args:**\n- `report_id` **(str):** ID of report. Get from URL.  \n    - E.g.: https://secure.holistics.io/queries/12345-processing-report (12345)\n- `path` **(str) (optional):** If you want to store export data to local path, set path variable.  \n    - Default value: None\n    - E.g: `'D:/Data/output.csv'`\n- `filter_dict` **(dict) (optional):** dictionary of filters that would be applied to report.  \n    - Default value: None\n    - E.g.: `{'tenant': 'holistics', 'date': '2017-04-28'}`\n- `_page_size` **(int) (optional):** Set the page size of the response.  \n    - Default value: 10000000\n- `_page` **(int) (optional):** Set the page number of data to fetch.  \n    - Default value: 10000000\n\n## **Return:**\nA DataFrame object. If `path` is not None, save object as `.csv` file at that path.\n\n## **Raises:**\n- `HTTPError`: Happen when the program cannot connect to target site and get data. \n   - You should check your API key or Holistics's URL or the Internet connection.\n- `RuntimeError`: If returned status is Failure. \n   - It could be caused by wrong SQL of your QueryReport.\n- `ParserError`: If program failed to parse downloaded data as `DataFrame` object. \n   - It could be caused when downloaded data is None.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fholistics%2Fholistics-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fholistics%2Fholistics-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fholistics%2Fholistics-python/lists"}