Skip to content
This repository was archived by the owner on Jun 28, 2022. It is now read-only.

Commit 3e8e14a

Browse files
committed
migrated to JL 3
1 parent 10f4555 commit 3e8e14a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+5820
-1953
lines changed

.bumpversion.cfg

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[bumpversion]
2-
current_version = 2.1.0-rc4
2+
current_version = 2.2.0-rc4
33
commit = False
44
tag = False
55
parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)\-{0,1}(?P<release>\D*)(?P<build>\d*)
@@ -22,10 +22,10 @@ parse = version = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)\-{0,1}(?P<relea
2222

2323
[bumpversion:file:databrickslabs_jupyterlab/_version.py]
2424

25-
[bumpversion:file:env.yml]
25+
[bumpversion:file:README.md]
2626
parse = databrickslabs_jupyterlab==(?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)\-{0,1}(?P<release>\D*)(?P<build>\d*)
2727

28-
[bumpversion:file:README.md]
28+
[bumpversion:file:docs/v2/troubleshooting.md]
2929
parse = databrickslabs_jupyterlab==(?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)\-{0,1}(?P<release>\D*)(?P<build>\d*)
3030

3131
[bumpversion:file:docker/image/Dockerfile]

HISTORY.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
### V2.2.0 (Apr 2021)
2+
3+
- **Jupyter Lab support**
4+
With support for Jupyterlab the installation could be simplified drastically
5+
6+
- **Support of Databricks Runtimes 6.4 and higher (incl 8.1)**
7+
18
### V2.1.0 (Jan 2021)
29

310
- **A new parser for ssh/config**

Makefile

Lines changed: 2 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -33,44 +33,21 @@ ext:
3333
bump:
3434
ifdef part
3535
ifdef version
36-
bumpversion --new-version $(version) $(part) && grep current .bumpversion.cfg
36+
bumpversion --allow-dirty --new-version $(version) $(part) && grep current .bumpversion.cfg
3737
else
38-
bumpversion $(part) && grep current .bumpversion.cfg
38+
bumpversion --allow-dirty $(part) && grep current .bumpversion.cfg
3939
endif
4040
else
4141
@echo "$(ERROR_COLOR)Provide part=major|minor|patch|release|build and optionally version=x.y.z...$(NO_COLOR)"
4242
exit 1
4343
endif
4444

45-
bump_ext:
46-
ifdef part
47-
$(eval cur_version=$(shell cd extensions/databrickslabs_jupyterlab_statusbar/ && npm version $(part) --preid=rc))
48-
else
49-
ifdef version
50-
$(eval cur_version := $(shell cd extensions/databrickslabs_jupyterlab_statusbar/ && npm version $(version)))
51-
else
52-
@echo "$(ERROR_COLOR)Provide part=major|minor|patch|premajor|preminor|prepatch|prerelease or version=x.y.z...$(NO_COLOR)"
53-
exit 1
54-
endif
55-
endif
56-
@echo "$(OK_COLOR)=> New version: $(cur_version:v%=%)$(NO_COLOR)"
57-
@sed -i.bak 's|databrickslabs-jupyterlab-statusbar@.*|databrickslabs-jupyterlab-statusbar@$(cur_version)|' labextensions.txt
58-
cat labextensions.txt
59-
git add labextensions.txt extensions/databrickslabs_jupyterlab_statusbar/package.json
60-
git commit -m "extension release $(cur_version)"
61-
6245
# Dist commands
6346

6447
# wheel:
6548

6649
dist:
67-
@mkdir -p databrickslabs_jupyterlab/lib
68-
@cp env.yml labextensions.txt "databrickslabs_jupyterlab/lib/"
69-
ifdef CLUSTER
70-
(DB_HOME=/databricks python setup.py sdist bdist_wheel)
71-
else
7250
python setup.py sdist bdist_wheel
73-
endif
7451

7552
dev_tag:
7653
git tag -a v$(CURRENT_VERSION) -m "Dev release: $(CURRENT_VERSION)"
@@ -95,17 +72,6 @@ check_dist:
9572
upload:
9673
@twine upload dist/*
9774

98-
upload_ext:
99-
cd extensions/databrickslabs_jupyterlab_statusbar && npm publish
100-
101-
# dev tools
102-
103-
check_version:
104-
dev_tools/check_versions env.yml
105-
106-
dev_tools:
107-
pip install twine bumpversion yapf pylint pyYaml pytest
108-
10975
docker:
11076
@cd docker/image && docker build -t bwalter42/databrickslabs_jupyterlab:$(CURRENT_VERSION) .
11177

README.md

Lines changed: 25 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -2,42 +2,28 @@
22

33
This package allows to connect to a remote Databricks cluster from a locally running JupyterLab.
44

5-
## >>> New minor release V2.1 (Jan 2021) <<<
6-
7-
## 1 New features
8-
9-
- A new parser for ssh/config that aims for minimum changes (including whitespaces and comments). For verification it shows the diff view to the original version:
10-
```text
11-
Host 0102-115241-craws1
12-
- HostName ec2-11-22-33-44.eu-central-1.compute.amazonaws.com
13-
+ HostName 111.222.333.444
14-
User ubuntu
15-
- Port 2200
16-
? ^^
17-
18-
+ Port 2222
19-
? ^^
20-
21-
IdentityFile ~/.ssh/id_aws-ffm
22-
ServerAliveInterval 30
23-
ConnectTimeout 5
24-
ServerAliveCountMax 5760
25-
```
26-
- SSH tunnels are now supported by setting the environment variable SSH_TUNNEL to `address:port` of the tunnel service. See above where a standard AWS Databricks hostname and port (`ec2-11-22-33-44.eu-central-1.compute.amazonaws.com`, `2200`) got replaced by a SSH tunnel at `111.222.333.444` and port `2222`.
27-
For the ssh tunnel one can use a managed service like [ngrok](https://ngrok.com/).
28-
Alternatively, build your own tunneling service based on e.g. [Fast Reverse Proxy (fpr)](https://github.com/fatedier/frp) as described in ![Fast Reverse proxy configuration](docs/v2/frp.md).
29-
In both cases, one will use it as
5+
6+
## >>> New minor release V2.2 (Apr 2021) <<<
7+
8+
### 1 New features
9+
10+
- **Jupyter Lab 3 support**
11+
12+
Jupyter Integration now works with JupyterLab 3. This drastically simplified the installation. The bootstrap step (`dj -b`) is gone. Simply:
3013

3114
```bash
32-
export SSH_TUNNEL=52.52.52.52:2222
33-
dj <profile> -k
15+
(base)$ conda create -n dj python=3.8 # you might need to add "pywin32" if you are on Windows
16+
(base)$ conda activate dj
17+
(dj)$ pip install --upgrade databrickslabs-jupyterlab[cli]==2.2.0-rc4
3418
```
3519

36-
- Support of Databricks Runtimes 6.4, 7.3 and 7.5 (standard and ML)
37-
38-
- A new flag "--env" allows to add extra environment variables available in the notebooks
20+
The following packages get installed:
21+
- databrickslabs-jupyterlab
22+
- databrickslabs-jupyterlab-status (providing the lab extension)
23+
- ssh-ipykernel
24+
- ssh-ipykernel-interrupt (providing the lab extension)
3925

40-
- Many bug fixes
26+
- Support of Databricks Runtimes 6.4, 6.4(ESR), 7.3 and 7.5, 8.0, 8.1 (standard and ML)
4127

4228
## 2 Overview
4329
![introduction](docs/v2/introduction.gif)
@@ -90,12 +76,14 @@ In both cases, one will use it as
9076
- *'6.4'* and *'6.4 ML'*
9177
- *'7.3'* and *'7.3 ML'*
9278
- *'7.5'* and *'7.5 ML'*
79+
- *'8-0'* and *'8.0 ML'*
80+
- *'8.1'* and *'8.1 ML'*
9381

9482
Newer runtimes might work, however are subject to own tests.
9583

9684
## 4 Running with docker
9785

98-
A docker image ready for working with *Jupyterlab Integration* is available from Dockerhub. It is recommended to prepare your environment by pulling the repository: `docker pull bwalter42/databrickslabs_jupyterlab:2.1.0-rc4`
86+
A docker image ready for working with *Jupyterlab Integration* is available from Dockerhub. It is recommended to prepare your environment by pulling the repository: `docker pull bwalter42/databrickslabs_jupyterlab:2.2.0-rc4`
9987

10088
There are two scripts in the folder `docker`:
10189

@@ -115,7 +103,7 @@ Alternatively, under macOS and Linux one can use the following bash functions:
115103
-v $HOME/.ssh/:/home/dbuser/.ssh \
116104
-v $HOME/.databrickscfg:/home/dbuser/.databrickscfg \
117105
-v $(pwd):/home/dbuser/notebooks \
118-
bwalter42/databrickslabs_jupyterlab:2.1.0-rc4 /opt/conda/bin/databrickslabs-jupyterlab $@
106+
bwalter42/databrickslabs_jupyterlab:2.2.0-rc4 /opt/conda/bin/databrickslabs-jupyterlab $@
119107
}
120108
```
121109

@@ -130,7 +118,7 @@ Alternatively, under macOS and Linux one can use the following bash functions:
130118
-v $HOME/.ssh/:/home/dbuser/.ssh \
131119
-v $HOME/.databrickscfg:/home/dbuser/.databrickscfg \
132120
-v $(pwd):/home/dbuser/notebooks \
133-
bwalter42/databrickslabs_jupyterlab:2.1.0-rc4 /opt/conda/bin/jupyter $@
121+
bwalter42/databrickslabs_jupyterlab:2.2.0-rc4 /opt/conda/bin/jupyter $@
134122
}
135123
```
136124

@@ -176,9 +164,9 @@ in both commands.
176164
Create a new conda environment and install *databrickslabs_jupyterlab* with the following commands:
177165

178166
```bash
179-
(base)$ conda create -n db-jlab21 python=3.8
180-
(base)$ conda activate db-jlab21
181-
(db-jlab)$ pip install --upgrade databrickslabs-jupyterlab==2.1.0-rc4
167+
(base)$ conda create -n dj python=3.8 # you might need to add "pywin32" if you are on Windows
168+
(base)$ conda activate dj
169+
(dj)$ pip install --upgrade databrickslabs-jupyterlab[cli]==2.2.0-rc4
182170
```
183171

184172
The prefix `(db-jlab)$` for all command examples in this document assumes that the conda enviromnent `db-jlab` is activated.
@@ -187,14 +175,6 @@ in both commands.
187175

188176
It comes with a batch file `dj.bat` for Windows. On MacOS or Linux both `dj` and `databrickslabs-jupyterlab` exist
189177

190-
3. **Bootstrap *Jupyterlab Integration***
191-
192-
Bootstrap the environment for *Jupyterlab Integration* with the following command (which will show the usage after successfully configuring *Juypterlab Integration*):
193-
194-
```bash
195-
(db-jlab)$ dj -b
196-
```
197-
198178
## 6 Getting started with local installation or docker
199179

200180
Ensure, ssh access is correctly configured, see [Configure SSH access](docs/ssh-configurations.md)

README_v1 (old).md

Lines changed: 0 additions & 142 deletions
This file was deleted.

0 commit comments

Comments
 (0)