vtlim commented on code in PR #13938: URL: https://github.com/apache/druid/pull/13938#discussion_r1137647530
########## examples/quickstart/jupyter-notebooks/druidapi/README.md: ########## @@ -36,21 +39,25 @@ At present, the best way to use `druidapi` is to clone the Druid repo itself: git clone [email protected]:apache/druid.git ``` -`druidapi` is located in `examples/quickstart/jupyter-notebooks/druidapi/` +`druidapi` is located in `examples/quickstart/jupyter-notebooks/druidapi/`. +From this directory, install the package and its dependencies with pip using the following command: -Eventually we would like to create a Python package that can be installed with `pip`. Contributions -in that area are welcome. +``` +pip install . +``` -Dependencies are listed in `requirements.txt`. +Verify your installation by checking that the following commands run in Python without error: -`druidapi` works against any version of Druid. Operations that exploit newer features obviously work -only against versions of Druid that support those features. +```python +import druidapi +druid = druidapi.jupyter_client('http://localhost:8888') +``` -## Getting Started +## Getting started To use `druidapi`, first import the library, then connect to your cluster by providing the URL to your Router instance. The way that is done differs a bit between consumers. -### From a Tutorial Jupyter Notebook +### From a tutorial Jupyter Notebook Review Comment: We use sentence case for headings as per the Google style guide: https://developers.google.com/style/capitalization. Will update `notebook` to lowercase n. -- 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]
