diff options
author | CoprDistGit <infra@openeuler.org> | 2023-04-11 14:37:04 +0000 |
---|---|---|
committer | CoprDistGit <infra@openeuler.org> | 2023-04-11 14:37:04 +0000 |
commit | b15ce97f6d8ebf78e69534bef5d3139a63ee16cd (patch) | |
tree | e1f424456663a2d3647bac66d7c6ffb946b9d35c | |
parent | 8251359f5b8cfa6d99b8b361fd1fbe0389889296 (diff) |
automatic import of python-redash-api-client
-rw-r--r-- | .gitignore | 1 | ||||
-rw-r--r-- | python-redash-api-client.spec | 1192 | ||||
-rw-r--r-- | sources | 1 |
3 files changed, 1194 insertions, 0 deletions
@@ -0,0 +1 @@ +/redash-api-client-0.3.0.tar.gz diff --git a/python-redash-api-client.spec b/python-redash-api-client.spec new file mode 100644 index 0000000..f62de37 --- /dev/null +++ b/python-redash-api-client.spec @@ -0,0 +1,1192 @@ +%global _empty_manifest_terminate_build 0 +Name: python-redash-api-client +Version: 0.3.0 +Release: 1 +Summary: Redash API Client +License: MIT License +URL: https://github.com/damnee562/redash-api-client +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/77/9a/7c3ac46c06a6c04bd0d96643921ad1b91c08a1f3b8901db4f27388c0c5b2/redash-api-client-0.3.0.tar.gz +BuildArch: noarch + +Requires: python3-requests + +%description +# Redash-API-Client + +[](https://pypi.org/project/redash-api-client/) +[](https://pypi.python.org/pypi/redash-api-client/) +[](https://pypi.python.org/pypi/redash-api-client/) +[](https://pepy.tech/project/redash-api-client) + +Redash API Client written in Python. + +## Dependencies + +* Python3.6+ + +## Installation + + pip install redash-api-client + +## Getting Started + +```python +from redashAPI import RedashAPIClient + +# Create API client instance +""" + :args: + API_KEY + REDASH_HOST (optional): `http://localhost:5000` by default +""" +Redash = RedashAPIClient(API_KEY, REDASH_HOST) +``` + +### Redash's RESTful API + +| URI | Supported Methods | +| ------------------ | ----------------------------- | +| *users* | **GET**, **POST** | +| *users/1* | **GET**, **POST** | +| *data_sources* | **GET**, **POST** | +| *data_sources/1* | **GET**, **POST**, **DELETE** | +| *queries* | **GET**, **POST** | +| *queries/1* | **GET**, **POST**, **DELETE** | +| *query_results* | **POST** | +| *query_results/1* | **GET** | +| *visualizations* | **POST** | +| *visualizations/1* | **POST**, **DELETE** | +| *dashboards* | **GET**, **POST** | +| *dashboards/slug* | **GET**, **POST**, **DELETE** | +| *widgets* | **POST** | +| *widgets/1* | **POST**, **DELETE** | + +```python +### EXAMPLE ### + +# List all Data Sources +res = Redash.get('data_sources') +res.json() +""" +[ + { + 'name': 'data_source1', + 'pause_reason': None, + 'syntax': 'sql', + 'paused': 0, + 'view_only': False, + 'type': 'pg', + 'id': 1 + }, + ... +] +""" + +# Retrieve specific Data Source +res = Redash.get('data_sources/1') +res.json() +""" +{ + "scheduled_queue_name": "scheduled_queries", + "name": "test1", + "pause_reason": "None", + "queue_name": "queries", + "syntax": "sql", + "paused": 0, + "options": { + "password": "--------", + "dbname": "bi", + "user": "" + }, + "groups": { + "1":False + }, + "type": "pg", + "id": 1 +} +""" + +# Create New Data Source +Redash.post('data_sources', { + "name": "New Data Source", + "type": "pg", + "options": { + "dbname": DB_NAME, + "host": DB_HOST, + "user": DB_USER, + "passwd": DB_PASSWORD, + "port": DB_PORT + } +}) +""" +{ + "scheduled_queue_name": "scheduled_queries", + "name": "New Data Source", + "pause_reason": "None", + "queue_name": "queries", + "syntax": "sql", + "paused": 0, + "options": { + "dbname": DB_NAME, + "host": DB_HOST, + "user": DB_USER, + "passwd": DB_PASSWORD, + "port": DB_PORT + }, + "groups": { + "2": False + }, + "type": "pg", + "id": 2 +} +""" + +# Delete specific Data Source +Redash.delete('data_sources/2') +``` + +### Create Data Source + +- **_type** + + - Type of Data Source. ([Supported types](https://github.com/getredash/redash/blob/ddb0ef15c1340e7de627e928f80486dfd3d6e1d5/redash/settings/__init__.py#L309-L358)) + +- **name** + + - Name for Data Source. + +- **options** + + - Configuration. + +```python +### EXAMPLE ### + +Redash.create_data_source("pg", "First Data Source", { + "dbname": DB_NAME, + "host": DB_HOST, + "user": DB_USER, + "passwd": DB_PASSWORD, + "port": DB_PORT +}) +``` + +### Create Query + +- **ds_id** + + - Data Source ID. + +- **name** + + - Name for query. + +- **qry** + + - Query string. + +- **desc (optional)** + + - Description. + +- **with_results (optional)** + + - Generate query results automatically, `True` by default. + +- **options (optional)** + + - Custom options. + +```python +### EXAMPLE ### + +Redash.create_query(1, "First Query", "SELECT * FROM table_name;") +``` + +### Refresh Query + +- **qry_id** + + - Query ID. + +```python +### EXAMPLE ### + +Redash.refresh_query(1) +``` + +### Generate Query Result + +- **ds_id** + + - Data Source ID. + +- **qry** + + - Query String. + +- **qry_id (optional)** + + - Query ID. + +- **max_age (optional)** + + - If query results less than *max_age* seconds old are available, + return them, otherwise execute the query; if omitted or -1, returns + any cached result, or executes if not available. Set to zero to + always execute. + +- **parameters (optional)** + + - A set of parameter values to apply to the query. + +- **return_results (optional)** + + - Return results if query is executed successfully, `True` by default. + +```python +### EXAMPLE ### + +Redash.generate_query_results(1) +``` + +### Query and Wait Result + +- **ds_id** + + - Data Source ID. + +- **qry** + + - Query String. + +- **timeout (optional)** + - Defines the time in seconds to wait before cutting the request. + +```python +### EXAMPLE ### + +Redash.query_and_wait_result(1, 'select * from my_table;', 60) +``` + +### Create Visualization + +- **qry_id** + + - Query ID. + +- **_type** + + - Type of Visualization. (`table`, `line`, `column`, `area`, `pie`, `scatter`, `bubble`, `box`, `pivot`) + +- **name** + + - Name for Visualization. + +- **columns (optional)** + + - Columns for Table. (Required if *_type* is `table`) + +- **x_axis (optional)** + + - Column for X Axis. (Required if *_type* is not `table` nor `pivot`) + +- **y_axis (optional)** + + - Columns for Y Axis (Required if *_type* is not `table` nor `pivot`) + +- **size_column (optional)** + + - Column for size. (Bubble) + +- **group_by (optional)** + + - Group by specific column. + +- **custom_options (optional)** + + - Custom options for Visualization. + +- **desc (optional)** + + - Description. + +```python +### EXAMPLE 1 ### + +Redash.create_visualization(1, "table", "First Visualization", columns=[ + {"name": "column1", "type": "string"}, + {"name": "column2", "type": "datetime"} +]) + +### EXAMPLE 2 ### +Redash.create_visualization(1, "line", "Second Visualization", x_axis="column1", y_axis=[ + {"type": "line", "name": "column2", "label": "c2"} +]) +``` + +### Create Dashboard + +- **name** + + - Name for Dashboard. + +```python +### EXAMPLE ### + +Redash.create_dashboard("First Dashboard") +``` + +### Add Widget into Dashboard + +- **db_id** + + - Dashboard ID. + +- **text (optional)** + + - Text Widget. + +- **vs_id (optional)** + + - Visualization ID. + +- **full_width (optional)** + + - Full width or not, `False` by default. + +- **position (optional)** + + - Custom position for Widget. + +```python +### EXAMPLE 1 ### + +Redash.add_widget(1, text="Test") + +### EXAMPLE 2 ### +Redash.add_widget(1, visualization_id=1, full_width=True) +``` + +### Publish Dashboard + +- **db_id** + + - Dashboard ID. + +```python +### EXAMPLE ### + +url = Redash.publish_dashboard(1) +``` + +## License +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. + + + + +%package -n python3-redash-api-client +Summary: Redash API Client +Provides: python-redash-api-client +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-redash-api-client +# Redash-API-Client + +[](https://pypi.org/project/redash-api-client/) +[](https://pypi.python.org/pypi/redash-api-client/) +[](https://pypi.python.org/pypi/redash-api-client/) +[](https://pepy.tech/project/redash-api-client) + +Redash API Client written in Python. + +## Dependencies + +* Python3.6+ + +## Installation + + pip install redash-api-client + +## Getting Started + +```python +from redashAPI import RedashAPIClient + +# Create API client instance +""" + :args: + API_KEY + REDASH_HOST (optional): `http://localhost:5000` by default +""" +Redash = RedashAPIClient(API_KEY, REDASH_HOST) +``` + +### Redash's RESTful API + +| URI | Supported Methods | +| ------------------ | ----------------------------- | +| *users* | **GET**, **POST** | +| *users/1* | **GET**, **POST** | +| *data_sources* | **GET**, **POST** | +| *data_sources/1* | **GET**, **POST**, **DELETE** | +| *queries* | **GET**, **POST** | +| *queries/1* | **GET**, **POST**, **DELETE** | +| *query_results* | **POST** | +| *query_results/1* | **GET** | +| *visualizations* | **POST** | +| *visualizations/1* | **POST**, **DELETE** | +| *dashboards* | **GET**, **POST** | +| *dashboards/slug* | **GET**, **POST**, **DELETE** | +| *widgets* | **POST** | +| *widgets/1* | **POST**, **DELETE** | + +```python +### EXAMPLE ### + +# List all Data Sources +res = Redash.get('data_sources') +res.json() +""" +[ + { + 'name': 'data_source1', + 'pause_reason': None, + 'syntax': 'sql', + 'paused': 0, + 'view_only': False, + 'type': 'pg', + 'id': 1 + }, + ... +] +""" + +# Retrieve specific Data Source +res = Redash.get('data_sources/1') +res.json() +""" +{ + "scheduled_queue_name": "scheduled_queries", + "name": "test1", + "pause_reason": "None", + "queue_name": "queries", + "syntax": "sql", + "paused": 0, + "options": { + "password": "--------", + "dbname": "bi", + "user": "" + }, + "groups": { + "1":False + }, + "type": "pg", + "id": 1 +} +""" + +# Create New Data Source +Redash.post('data_sources', { + "name": "New Data Source", + "type": "pg", + "options": { + "dbname": DB_NAME, + "host": DB_HOST, + "user": DB_USER, + "passwd": DB_PASSWORD, + "port": DB_PORT + } +}) +""" +{ + "scheduled_queue_name": "scheduled_queries", + "name": "New Data Source", + "pause_reason": "None", + "queue_name": "queries", + "syntax": "sql", + "paused": 0, + "options": { + "dbname": DB_NAME, + "host": DB_HOST, + "user": DB_USER, + "passwd": DB_PASSWORD, + "port": DB_PORT + }, + "groups": { + "2": False + }, + "type": "pg", + "id": 2 +} +""" + +# Delete specific Data Source +Redash.delete('data_sources/2') +``` + +### Create Data Source + +- **_type** + + - Type of Data Source. ([Supported types](https://github.com/getredash/redash/blob/ddb0ef15c1340e7de627e928f80486dfd3d6e1d5/redash/settings/__init__.py#L309-L358)) + +- **name** + + - Name for Data Source. + +- **options** + + - Configuration. + +```python +### EXAMPLE ### + +Redash.create_data_source("pg", "First Data Source", { + "dbname": DB_NAME, + "host": DB_HOST, + "user": DB_USER, + "passwd": DB_PASSWORD, + "port": DB_PORT +}) +``` + +### Create Query + +- **ds_id** + + - Data Source ID. + +- **name** + + - Name for query. + +- **qry** + + - Query string. + +- **desc (optional)** + + - Description. + +- **with_results (optional)** + + - Generate query results automatically, `True` by default. + +- **options (optional)** + + - Custom options. + +```python +### EXAMPLE ### + +Redash.create_query(1, "First Query", "SELECT * FROM table_name;") +``` + +### Refresh Query + +- **qry_id** + + - Query ID. + +```python +### EXAMPLE ### + +Redash.refresh_query(1) +``` + +### Generate Query Result + +- **ds_id** + + - Data Source ID. + +- **qry** + + - Query String. + +- **qry_id (optional)** + + - Query ID. + +- **max_age (optional)** + + - If query results less than *max_age* seconds old are available, + return them, otherwise execute the query; if omitted or -1, returns + any cached result, or executes if not available. Set to zero to + always execute. + +- **parameters (optional)** + + - A set of parameter values to apply to the query. + +- **return_results (optional)** + + - Return results if query is executed successfully, `True` by default. + +```python +### EXAMPLE ### + +Redash.generate_query_results(1) +``` + +### Query and Wait Result + +- **ds_id** + + - Data Source ID. + +- **qry** + + - Query String. + +- **timeout (optional)** + - Defines the time in seconds to wait before cutting the request. + +```python +### EXAMPLE ### + +Redash.query_and_wait_result(1, 'select * from my_table;', 60) +``` + +### Create Visualization + +- **qry_id** + + - Query ID. + +- **_type** + + - Type of Visualization. (`table`, `line`, `column`, `area`, `pie`, `scatter`, `bubble`, `box`, `pivot`) + +- **name** + + - Name for Visualization. + +- **columns (optional)** + + - Columns for Table. (Required if *_type* is `table`) + +- **x_axis (optional)** + + - Column for X Axis. (Required if *_type* is not `table` nor `pivot`) + +- **y_axis (optional)** + + - Columns for Y Axis (Required if *_type* is not `table` nor `pivot`) + +- **size_column (optional)** + + - Column for size. (Bubble) + +- **group_by (optional)** + + - Group by specific column. + +- **custom_options (optional)** + + - Custom options for Visualization. + +- **desc (optional)** + + - Description. + +```python +### EXAMPLE 1 ### + +Redash.create_visualization(1, "table", "First Visualization", columns=[ + {"name": "column1", "type": "string"}, + {"name": "column2", "type": "datetime"} +]) + +### EXAMPLE 2 ### +Redash.create_visualization(1, "line", "Second Visualization", x_axis="column1", y_axis=[ + {"type": "line", "name": "column2", "label": "c2"} +]) +``` + +### Create Dashboard + +- **name** + + - Name for Dashboard. + +```python +### EXAMPLE ### + +Redash.create_dashboard("First Dashboard") +``` + +### Add Widget into Dashboard + +- **db_id** + + - Dashboard ID. + +- **text (optional)** + + - Text Widget. + +- **vs_id (optional)** + + - Visualization ID. + +- **full_width (optional)** + + - Full width or not, `False` by default. + +- **position (optional)** + + - Custom position for Widget. + +```python +### EXAMPLE 1 ### + +Redash.add_widget(1, text="Test") + +### EXAMPLE 2 ### +Redash.add_widget(1, visualization_id=1, full_width=True) +``` + +### Publish Dashboard + +- **db_id** + + - Dashboard ID. + +```python +### EXAMPLE ### + +url = Redash.publish_dashboard(1) +``` + +## License +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. + + + + +%package help +Summary: Development documents and examples for redash-api-client +Provides: python3-redash-api-client-doc +%description help +# Redash-API-Client + +[](https://pypi.org/project/redash-api-client/) +[](https://pypi.python.org/pypi/redash-api-client/) +[](https://pypi.python.org/pypi/redash-api-client/) +[](https://pepy.tech/project/redash-api-client) + +Redash API Client written in Python. + +## Dependencies + +* Python3.6+ + +## Installation + + pip install redash-api-client + +## Getting Started + +```python +from redashAPI import RedashAPIClient + +# Create API client instance +""" + :args: + API_KEY + REDASH_HOST (optional): `http://localhost:5000` by default +""" +Redash = RedashAPIClient(API_KEY, REDASH_HOST) +``` + +### Redash's RESTful API + +| URI | Supported Methods | +| ------------------ | ----------------------------- | +| *users* | **GET**, **POST** | +| *users/1* | **GET**, **POST** | +| *data_sources* | **GET**, **POST** | +| *data_sources/1* | **GET**, **POST**, **DELETE** | +| *queries* | **GET**, **POST** | +| *queries/1* | **GET**, **POST**, **DELETE** | +| *query_results* | **POST** | +| *query_results/1* | **GET** | +| *visualizations* | **POST** | +| *visualizations/1* | **POST**, **DELETE** | +| *dashboards* | **GET**, **POST** | +| *dashboards/slug* | **GET**, **POST**, **DELETE** | +| *widgets* | **POST** | +| *widgets/1* | **POST**, **DELETE** | + +```python +### EXAMPLE ### + +# List all Data Sources +res = Redash.get('data_sources') +res.json() +""" +[ + { + 'name': 'data_source1', + 'pause_reason': None, + 'syntax': 'sql', + 'paused': 0, + 'view_only': False, + 'type': 'pg', + 'id': 1 + }, + ... +] +""" + +# Retrieve specific Data Source +res = Redash.get('data_sources/1') +res.json() +""" +{ + "scheduled_queue_name": "scheduled_queries", + "name": "test1", + "pause_reason": "None", + "queue_name": "queries", + "syntax": "sql", + "paused": 0, + "options": { + "password": "--------", + "dbname": "bi", + "user": "" + }, + "groups": { + "1":False + }, + "type": "pg", + "id": 1 +} +""" + +# Create New Data Source +Redash.post('data_sources', { + "name": "New Data Source", + "type": "pg", + "options": { + "dbname": DB_NAME, + "host": DB_HOST, + "user": DB_USER, + "passwd": DB_PASSWORD, + "port": DB_PORT + } +}) +""" +{ + "scheduled_queue_name": "scheduled_queries", + "name": "New Data Source", + "pause_reason": "None", + "queue_name": "queries", + "syntax": "sql", + "paused": 0, + "options": { + "dbname": DB_NAME, + "host": DB_HOST, + "user": DB_USER, + "passwd": DB_PASSWORD, + "port": DB_PORT + }, + "groups": { + "2": False + }, + "type": "pg", + "id": 2 +} +""" + +# Delete specific Data Source +Redash.delete('data_sources/2') +``` + +### Create Data Source + +- **_type** + + - Type of Data Source. ([Supported types](https://github.com/getredash/redash/blob/ddb0ef15c1340e7de627e928f80486dfd3d6e1d5/redash/settings/__init__.py#L309-L358)) + +- **name** + + - Name for Data Source. + +- **options** + + - Configuration. + +```python +### EXAMPLE ### + +Redash.create_data_source("pg", "First Data Source", { + "dbname": DB_NAME, + "host": DB_HOST, + "user": DB_USER, + "passwd": DB_PASSWORD, + "port": DB_PORT +}) +``` + +### Create Query + +- **ds_id** + + - Data Source ID. + +- **name** + + - Name for query. + +- **qry** + + - Query string. + +- **desc (optional)** + + - Description. + +- **with_results (optional)** + + - Generate query results automatically, `True` by default. + +- **options (optional)** + + - Custom options. + +```python +### EXAMPLE ### + +Redash.create_query(1, "First Query", "SELECT * FROM table_name;") +``` + +### Refresh Query + +- **qry_id** + + - Query ID. + +```python +### EXAMPLE ### + +Redash.refresh_query(1) +``` + +### Generate Query Result + +- **ds_id** + + - Data Source ID. + +- **qry** + + - Query String. + +- **qry_id (optional)** + + - Query ID. + +- **max_age (optional)** + + - If query results less than *max_age* seconds old are available, + return them, otherwise execute the query; if omitted or -1, returns + any cached result, or executes if not available. Set to zero to + always execute. + +- **parameters (optional)** + + - A set of parameter values to apply to the query. + +- **return_results (optional)** + + - Return results if query is executed successfully, `True` by default. + +```python +### EXAMPLE ### + +Redash.generate_query_results(1) +``` + +### Query and Wait Result + +- **ds_id** + + - Data Source ID. + +- **qry** + + - Query String. + +- **timeout (optional)** + - Defines the time in seconds to wait before cutting the request. + +```python +### EXAMPLE ### + +Redash.query_and_wait_result(1, 'select * from my_table;', 60) +``` + +### Create Visualization + +- **qry_id** + + - Query ID. + +- **_type** + + - Type of Visualization. (`table`, `line`, `column`, `area`, `pie`, `scatter`, `bubble`, `box`, `pivot`) + +- **name** + + - Name for Visualization. + +- **columns (optional)** + + - Columns for Table. (Required if *_type* is `table`) + +- **x_axis (optional)** + + - Column for X Axis. (Required if *_type* is not `table` nor `pivot`) + +- **y_axis (optional)** + + - Columns for Y Axis (Required if *_type* is not `table` nor `pivot`) + +- **size_column (optional)** + + - Column for size. (Bubble) + +- **group_by (optional)** + + - Group by specific column. + +- **custom_options (optional)** + + - Custom options for Visualization. + +- **desc (optional)** + + - Description. + +```python +### EXAMPLE 1 ### + +Redash.create_visualization(1, "table", "First Visualization", columns=[ + {"name": "column1", "type": "string"}, + {"name": "column2", "type": "datetime"} +]) + +### EXAMPLE 2 ### +Redash.create_visualization(1, "line", "Second Visualization", x_axis="column1", y_axis=[ + {"type": "line", "name": "column2", "label": "c2"} +]) +``` + +### Create Dashboard + +- **name** + + - Name for Dashboard. + +```python +### EXAMPLE ### + +Redash.create_dashboard("First Dashboard") +``` + +### Add Widget into Dashboard + +- **db_id** + + - Dashboard ID. + +- **text (optional)** + + - Text Widget. + +- **vs_id (optional)** + + - Visualization ID. + +- **full_width (optional)** + + - Full width or not, `False` by default. + +- **position (optional)** + + - Custom position for Widget. + +```python +### EXAMPLE 1 ### + +Redash.add_widget(1, text="Test") + +### EXAMPLE 2 ### +Redash.add_widget(1, visualization_id=1, full_width=True) +``` + +### Publish Dashboard + +- **db_id** + + - Dashboard ID. + +```python +### EXAMPLE ### + +url = Redash.publish_dashboard(1) +``` + +## License +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. + + + + +%prep +%autosetup -n redash-api-client-0.3.0 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-redash-api-client -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 0.3.0-1 +- Package Spec generated @@ -0,0 +1 @@ +94b5f629e848a3d2ccab0c5a42fd98a5 redash-api-client-0.3.0.tar.gz |