317brian commented on code in PR #13938:
URL: https://github.com/apache/druid/pull/13938#discussion_r1137843593
##########
examples/quickstart/jupyter-notebooks/README.md:
##########
@@ -65,6 +65,13 @@ Make sure you meet the following requirements before
starting the Jupyter-based
jupyter notebook --port 3001
```
+- The Python API client for Druid. From the Druid repo in
`examples/quickstart/jupyter-notebooks/druidapi`
Review Comment:
Do we say anywhere that they need to clone the repo first in this file? It
says it in the druidapi README
Also `From the Druid repo in ...` sounds kinda awkward although I'm not sure
if what I suggested is any better :|
```suggestion
- The Python API client for Druid. In
`examples/quickstart/jupyter-notebooks/druidapi` of the Druid repo,
```
##########
examples/quickstart/jupyter-notebooks/README.md:
##########
@@ -65,6 +65,13 @@ Make sure you meet the following requirements before
starting the Jupyter-based
jupyter notebook --port 3001
```
+- The Python API client for Druid. From the Druid repo in
`examples/quickstart/jupyter-notebooks/druidapi`
+ install `druidapi` with the following command:
+
+ ```bash
+ pip install .
+ ```
+
- An available Druid instance. You can use the `micro-quickstart` configuration
described in
[Quickstart](https://druid.apache.org/docs/latest/tutorials/index.html).
Review Comment:
micro-quickstart is gone. I thought we fixed that
```suggestion
- An available Druid instance. You can use the [quickstart
deployment](https://druid.apache.org/docs/latest/tutorials/index.html).
```
##########
examples/quickstart/jupyter-notebooks/druidapi/README.md:
##########
@@ -36,21 +39,27 @@ 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:
+
+```
+pip install .
+```
-Eventually we would like to create a Python package that can be installed with
`pip`. Contributions
-in that area are welcome.
+Note that there is a second level `druidapi` directory that contains the
modules. Do not run
+the install command in this internal folder.
Review Comment:
We usually refer to it as a child or subdirectory and not an internal
folder, right?
##########
examples/quickstart/jupyter-notebooks/druidapi/README.md:
##########
@@ -36,21 +39,27 @@ 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:
+
+```
+pip install .
+```
-Eventually we would like to create a Python package that can be installed with
`pip`. Contributions
-in that area are welcome.
+Note that there is a second level `druidapi` directory that contains the
modules. Do not run
+the install command in this internal folder.
-Dependencies are listed in `requirements.txt`.
+Verify your installation by checking that the following command runs in Python
without error:
Review Comment:
```suggestion
Verify your installation by checking that the following command runs in
Python:
```
##########
examples/quickstart/jupyter-notebooks/druidapi/README.md:
##########
@@ -36,21 +39,27 @@ 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:
+
+```
+pip install .
+```
-Eventually we would like to create a Python package that can be installed with
`pip`. Contributions
-in that area are welcome.
+Note that there is a second level `druidapi` directory that contains the
modules. Do not run
+the install command in this internal folder.
-Dependencies are listed in `requirements.txt`.
+Verify your installation by checking that the following command runs 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
+```
-## Getting Started
+## Getting started
Review Comment:
```suggestion
The import statement should not return anything if it runs successfully.
## Getting started
```
##########
examples/quickstart/jupyter-notebooks/druidapi/README.md:
##########
@@ -28,6 +28,9 @@ in any Python environment, but is optimized for use in
Jupyter, providing a comp
environment which complements the UI-based Druid console. The primary use of
`druidapi` at present
is to support the set of tutorial notebooks provided in the parent directory.
+`druidapi` works against any version of Druid. Operations that exploit newer
features obviously work
Review Comment:
```suggestion
`druidapi` works against any version of Druid. Operations that make use of
newer features obviously work
```
--
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]
