paul-rogers opened a new pull request, #13787: URL: https://github.com/apache/druid/pull/13787
We recently introduced a Jupyter notebook to explain how to use the Druid REST API. That notebook works though the detailed, low-level steps to use the Python `requests` package to make selected Druid REST calls. The result is excellent for explaining the mechanics of each REST call, but a bit fiddly if we want to create a notebook that explains Druid concepts (rather than REST concepts.) In response, this PR introduces a Python-based Druid API (or SDK) that handles the boilerplate of using `requests` to call Druid and parse the JSON results. What was many lines of Python code at the REST level is now a single line of code at the Druid SDK level. The PR includes an "intro to the Python API" notebook which is not an exhaustive reference. Rather, it gives just enough information to see how to use the API, and explains how to get the details. A later PR will include a notebook that uses this API to explain a new feature. The PR also revises existing notebooks and the README to reference the new API. The previous `README.md` didn't play when viewed in Jupyter: it seems Jupyter doesn't know how to render such files (oddly). Instead, the file was split into a "pre-Juypter" README that explains how to get started, and a post-Jupyter "- START HERE -" notebook that has the rest of the information once Jupyter is up and running. Updated the doc files accordingly. Note that this PR changes no "production" code: everything is confined to the `quickstart` examples. <!-- Thanks for trying to help us make Apache Druid be the best it can be! Please fill out as much of the following information as is possible (where relevant, and remove it when irrelevant) to help make the intention and scope of this PR clear in order to ease review. --> #### Release note This release extends the tutorial Jupyter notebooks to add a simple Python API to access Druid, along with a notebook that explains how to use that API. <hr> This PR has: - [X] been self-reviewed. - [X] added documentation for new or modified features or behaviors. - [X] a release note entry in the PR description. - [X] added comments explaining the "why" and the intent of the code wherever would not be obvious for an unfamiliar reader. -- 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]
