https://github.com/holistics/holistics-python
Python library for Holistics (using Holistics API)
https://github.com/holistics/holistics-python
api library python
Last synced: 11 months ago
JSON representation
Python library for Holistics (using Holistics API)
- Host: GitHub
- URL: https://github.com/holistics/holistics-python
- Owner: holistics
- License: mit
- Created: 2018-06-20T12:22:02.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2021-03-01T04:32:43.000Z (over 5 years ago)
- Last Synced: 2025-07-15T18:07:25.215Z (12 months ago)
- Topics: api, library, python
- Language: Python
- Size: 121 KB
- Stars: 7
- Watchers: 13
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Python Library for Holistics API
Our package ([**Holistics Package for Python**](https://github.com/holistics/holistics-python)) allow Python's user export report's data by inputting:
- Your API-key
- Report's ID
- Dictionary of filters applied to that report
# **Installation**
Package can be installed with `pip`:
```
pip install holistics
```
Alternatively, you can grab the latest source code from GitHub:
```python
git clone git://github.com/holistics/holistics-python.git
cd holistics-python
python setup.py install
```
# **How to export data**
Beginning by import holistics package
```python
from holistics import HolisticsAPI
```
Next, creating an object of HolisticsAPI class with your API-key and Holistics server's url
```python
obj = HolisticsAPI(api_key = 'aerg454hoiaKJGlgku', url = 'demo.holistics.io')
```
**Args:**
- `api_key` **(str):** Your account's API-key.
- [How to generate API-key](https://docs.holistics.io/api/)
- `url` **(str) (optional):** URL of your Holistics server
- Default value: 'https://secure.holistics.io'
Finally, call export_data function with specific syntax:
```python
export_data (report_id, path, filter_dict, _page_size, _page)
```
For example:
```python
my_dataframe = obj.export_data(report_id='123456', path='C:/output.csv',
filter_dict={'date': '2017-04-28', 'vat': 1.1},
_page_size = 12, _page = 5)
```
**Args:**
- `report_id` **(str):** ID of report. Get from URL.
- E.g.: https://secure.holistics.io/queries/12345-processing-report (12345)
- `path` **(str) (optional):** If you want to store export data to local path, set path variable.
- Default value: None
- E.g: `'D:/Data/output.csv'`
- `filter_dict` **(dict) (optional):** dictionary of filters that would be applied to report.
- Default value: None
- E.g.: `{'tenant': 'holistics', 'date': '2017-04-28'}`
- `_page_size` **(int) (optional):** Set the page size of the response.
- Default value: 10000000
- `_page` **(int) (optional):** Set the page number of data to fetch.
- Default value: 10000000
## **Return:**
A DataFrame object. If `path` is not None, save object as `.csv` file at that path.
## **Raises:**
- `HTTPError`: Happen when the program cannot connect to target site and get data.
- You should check your API key or Holistics's URL or the Internet connection.
- `RuntimeError`: If returned status is Failure.
- It could be caused by wrong SQL of your QueryReport.
- `ParserError`: If program failed to parse downloaded data as `DataFrame` object.
- It could be caused when downloaded data is None.