betodealmeida opened a new pull request #18123: URL: https://github.com/apache/superset/pull/18123
<!--- Please write the PR title following the conventions at https://www.conventionalcommits.org/en/v1.0.0/ Example: fix(dashboard): load charts correctly --> ### SUMMARY <!--- Describe the change below, including rationale and design decisions --> Users often ask how to run queries against Superset programmatically, and the answer [is not trivial](https://apache-superset.slack.com/archives/C015WAZL0KH/p1613756286186400). I added a small client called `SupersetClient` that takes care of the weird auth we use for SQL Lab (`/superset/sql_json`), simplifying the process. ### BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF <!--- Skip this if not applicable --> N/A ### TESTING INSTRUCTIONS <!--- Required! What steps can be taken to manually verify the changes? --> ```bash $ pip install 'superset[client]' ``` ```python >>> from superset.client import SupersetClient >>> client = SupersetClient("http://localhost:8088/";, "admin", "admin") >>> print(client.databases) [<Database "examples" (postgres)>] >>> examples = client.databases[0] >>> sql = "SELECT platform, rank FROM video_game_sales LIMIT 2" >>> print(examples.run_query(sql)) platform rank 0 Wii 1 1 NES 2 ``` ### ADDITIONAL INFORMATION <!--- Check any relevant boxes with "x" --> <!--- HINT: Include "Fixes #nnn" if you are fixing an existing issue --> - [ ] Has associated issue: - [ ] Required feature flags: - [ ] Changes UI - [ ] Includes DB Migration (follow approval process in [SIP-59](https://github.com/apache/superset/issues/13351)) - [ ] Migration is atomic, supports rollback & is backwards-compatible - [ ] Confirm DB migration upgrade and downgrade tested - [ ] Runtime estimates and downtime expectations provided - [ ] Introduces new feature or API - [ ] Removes existing feature or API -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
