Example script: delete queries #121
Conversation
|
I got the following message in CI, Could you please teach me how to fix it? |
|
Thanks for your contribution. The restyled bot enforces our code format (we use black). If a pull request didn't use black, restyled-bot automatically makes a pull request against the original pull request that adds black formatting. Since you closed your PR and reopened it, restyled bot closed its original pull request. But the check still fails because your code hasn't yet been formatted. You can do this locally with |
| @@ -26,6 +26,7 @@ find-tables = "redash_toolbelt.examples.find_table_names:main" | |||
| clone-dashboard-and-queries = "redash_toolbelt.examples.clone_dashboard_and_queries:main" | |||
| export-queries = "redash_toolbelt.examples.query_export:main" | |||
| redash-migrate = "redash_toolbelt.examples.migrate:main" | |||
| delete-queries = "redash_toolbelt.examples.delete_queries:main" | |||
There was a problem hiding this comment.
Does this really require an example script? If it does, "delete queries" (plural) is the wrong name for it since your example accepts a single query_id (not plural).
Not every example requires an entry under tool.poetry.scripts either. The purpose of examples is to show how to use redash-toolbelt.
I suppose it's okay to have such a simple example here, but it should be named correctly.
| template = u"""/* | ||
| API KEY: {name} | ||
| */ | ||
| {query}""" | ||
|
|
There was a problem hiding this comment.
Not sure the purpose of this...
| template = u"""/* | |
| API KEY: {name} | |
| */ | |
| {query}""" |
| ) | ||
|
|
||
| def main(redash_url, api_key, query_id): | ||
| redash = Redash(redash_url, api_key) |
There was a problem hiding this comment.
You need a docstring here. Users will see it when they call
$ delete-queries --help
| def main(redash_url, api_key, query_id): | ||
| redash = Redash(redash_url, api_key) | ||
| path = f'api/queries/{query_id}' | ||
| redash._delete(path) |
There was a problem hiding this comment.
Since this is a user-facing script, you should catch exceptions explicitly to notify the user whether the operation succeeded or failed.
I added CLI script for delete(archive) query.