https://github.com/getredash/redash-toolbelt
API client and utilities to manage a Redash instance
https://github.com/getredash/redash-toolbelt
Last synced: about 1 year ago
JSON representation
API client and utilities to manage a Redash instance
- Host: GitHub
- URL: https://github.com/getredash/redash-toolbelt
- Owner: getredash
- License: bsd-2-clause
- Created: 2020-01-08T07:12:15.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-08T16:11:48.000Z (over 2 years ago)
- Last Synced: 2025-05-10T15:50:14.843Z (about 1 year ago)
- Language: Python
- Size: 74.2 KB
- Stars: 147
- Watchers: 14
- Forks: 76
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
redash-toolbelt - The official API client and utilities to manage a Redash instance
- [INSTALLATION](#installation)
- [EXAMPLE SCRIPTS](#example-scripts)
## INSTALLATION
To install it you will need Python 3.6 or above. We recommend that you use a [virtual environment].
```bash
pip install --upgrade redash-toolbelt
```
This command will update `redash-toolbelt` if you have already installed it.
[virtual environment]: https://pythonbasics.org/virtualenv/
## EXAMPLE SCRIPTS
With `redash-toolbelt` installed you will have access to several example CLI scripts within your terminal.
```text
gdpr-scrub Search for a string term in your Redash queries
and query results. The script returns a list of
URLs in your instance that contain references to
the search term you provide
find-tables Search the text of queries against a data source
to see which table names are used in queries of
that source. This script relies on regex that is
tested against ANSI SQL.
clone-dashboard-and-queries Completely duplicate a dashboard by copying all
its queries and visualizations.
export-queries Export all the queries of your Redash instance
as text files.
redash-migrate Move data from one instance of Redash to another.
See docs/redash-migrate/README.md for more info
```