jupyterlab-pioneer 0.1.7 → 0.1.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -11,7 +11,7 @@ A JupyterLab extension for generating and exporting JupyterLab event telemetry d
|
|
|
11
11
|
|
|
12
12
|
```bash
|
|
13
13
|
# enter the configuration_examples directory and run
|
|
14
|
-
docker compose -p
|
|
14
|
+
docker compose -p jupyterlab_pioneer up --build
|
|
15
15
|
```
|
|
16
16
|
|
|
17
17
|
A JupyterLab application with the extension installed and configured will run on localhost:8888.
|
|
@@ -23,7 +23,7 @@ A JupyterLab application with the extension installed and configured will run on
|
|
|
23
23
|
To install the extension, execute:
|
|
24
24
|
|
|
25
25
|
```bash
|
|
26
|
-
pip install
|
|
26
|
+
pip install jupyterlab_pioneer
|
|
27
27
|
```
|
|
28
28
|
|
|
29
29
|
Before starting Jupyter Lab, users need to write their own configuration files (or use the provided configuration examples) and **place them in the correct directory**.
|
|
@@ -61,7 +61,7 @@ Check jupyter server [doc](https://jupyter-server.readthedocs.io/en/latest/opera
|
|
|
61
61
|
|
|
62
62
|
```python
|
|
63
63
|
{
|
|
64
|
-
'name':
|
|
64
|
+
'name': # string, event name
|
|
65
65
|
'logWholeNotebook': # boolean, whether to export the entire notebook content when event is triggered
|
|
66
66
|
}
|
|
67
67
|
```
|
|
@@ -74,12 +74,12 @@ The extension will export the entire notebook content only for valid events with
|
|
|
74
74
|
|
|
75
75
|
```python
|
|
76
76
|
{
|
|
77
|
-
'type': #
|
|
77
|
+
'type': # One of 'console_exporter', 'command_line_exporter',
|
|
78
78
|
# 'file_exporter', 'remote_exporter',
|
|
79
79
|
# or 'custom_exporter'.
|
|
80
|
-
'args': #
|
|
80
|
+
'args': # Optional. Arguments passed to the exporter function.
|
|
81
81
|
# It needs to contain 'path' for file_exporter, 'url' for remote_exporter.
|
|
82
|
-
'activeEvents': #
|
|
82
|
+
'activeEvents': # Optional. Exporter's local activeEvents config will override global activeEvents config
|
|
83
83
|
}
|
|
84
84
|
```
|
|
85
85
|
|
|
@@ -121,6 +121,12 @@ jupyter labextension list
|
|
|
121
121
|
|
|
122
122
|
### Development install
|
|
123
123
|
|
|
124
|
+
#### (Optional) create conda environment from the provided `environment.yml` file
|
|
125
|
+
```bash
|
|
126
|
+
conda env create -f environment.yml
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
#### Clone and build the extension package
|
|
124
130
|
Note: You will need NodeJS to build the extension package.
|
|
125
131
|
|
|
126
132
|
The `jlpm` command is JupyterLab's pinned version of
|
|
@@ -129,7 +135,7 @@ The `jlpm` command is JupyterLab's pinned version of
|
|
|
129
135
|
|
|
130
136
|
```bash
|
|
131
137
|
# Clone the repo to your local environment
|
|
132
|
-
# Change directory to the
|
|
138
|
+
# Change directory to the jupyterlab-pioneer directory
|
|
133
139
|
# Install package in development mode
|
|
134
140
|
pip install -e "."
|
|
135
141
|
# Link your development version of the extension with JupyterLab
|