Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blacksuan19/redash-python
A More complete Redash API python client
https://github.com/blacksuan19/redash-python
dashboards data-science data-visualization python
Last synced: about 13 hours ago
JSON representation
A More complete Redash API python client
- Host: GitHub
- URL: https://github.com/blacksuan19/redash-python
- Owner: Blacksuan19
- License: bsd-2-clause
- Created: 2022-08-08T09:39:19.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-07-17T10:54:12.000Z (over 1 year ago)
- Last Synced: 2024-11-14T16:21:02.104Z (3 days ago)
- Topics: dashboards, data-science, data-visualization, python
- Language: Python
- Homepage: https://redash.blacksuan19.dev/
- Size: 1.99 MB
- Stars: 7
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Redash API Python Client
python package for interacting with the Redash API
[](https://pypi.org/project/redash-python "view package on PyPi")
[](https://redash.blacksuan19.dev/ "go to documentation")
[](# "Build with github actions")
## Features
- Complete access to all endpoints in the Redash API.
- Pagination by default.
- Duplicate dashboards.
- Manage users and groups.
- Duplicate queries with different source tables.
### Implemented Services
- [x] Dashboards
- [x] Queries
- [x] Data Sources
- [x] Alerts
- [x] Users
- [x] Destinations
- [x] Groups
- [x] query_snippets
- [x] Widgets\*
\* widgets endpoint does not support GET requests, only update, delete and
create.
## Getting Started
an API key is required in addition to the instance's host URL.
### Installation
```bash
pip install redash-python
```
### Usage
```python
from redash_python import Redash
rd = Redash(base_url="", api_key="")
# get all dashboards
dashboards = rd.dashboards.get_all()
# get specific dashboards by id
dash = rd.dashboards.get(1)
# get by slug or name
query = rd.queries.get_by_name("my-dashboard")
# get by tags
q = rd.queries.get_by_tags(["my-tag"])
# get without tags
dash = rd.dashboards.get_by_tags(["my-tag"], without=True)
# Duplicate query with a different table as source
ques = rd.queries
ques.duplicate_query_table(
query=ques.get(1),
table_map={"old_table": "new_table"},
tags=["admin", "test"],
publish=True,
)
# get a list of implemented API endpoints
print(rd.services)
# get a list of implemented endpoints in a service
print(rd.users)
```
for a full list of implemented methods in each service, print the service
object.
```python
>>> print(client.dashboards)
DashboardsService(attributes: ['endpoint'], methods: ['create', 'create_widget', 'delete', 'duplicate', 'exists', 'favorite', 'favorited', 'get', 'get_all', 'get_by_name', 'get_by_tags', 'get_id', 'get_slug', 'paginate', 'publish', 'refresh', 'share', 'unfavorite', 'unpublish', 'update'])
```
for more examples on usage, see examples folder on github.
## Development
before starting development, install dev dependencies:
```bash
pip install redash-python[dev]
```
### Architecture
this library implements a services based architecture splitting each API
endpoint group to its own service, on top of which is the `Redash` class. all
the services share base classes from mixins that make it easier to share common
behavior and allows rapid development for any new endpoints. for instance adding
query_snippets is as simple as:
```python
from .base import BaseService
from .mixins import CommonMixin, NameMixin, PrintMixin
class QSnipsService(CommonMixin, NameMixin, PrintMixin):
def __init__(self, base: BaseService) -> None:
# init mixins
CommonMixin.__init__(self, base)
self.__base = base
self.endpoint = "/api/query_snippets"
```
### Directory Structure
```bash
redash_python
├── __init__.py
├── redash.py # Services wrapper
└── services # implemented services
├── base.py # Base service class
└── mixins.py # Mixins for services with shared functionality
```
## Contributing
Contributions are welcome, please open an issue or PR to propose any changes.
## License
[](https://github.com/Blacksuan19/redash-python/blob/master/LICENSE "View License")