Skip to content

Commit c208f49

Browse files
committed
Add LICENSE to Dockerfile and update README
1 parent 29e57da commit c208f49

File tree

2 files changed

+28
-22
lines changed

2 files changed

+28
-22
lines changed

Dockerfile

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1+
# Copyright (c) 2020 Trevor Sullivan
2+
3+
# Permission is hereby granted, free of charge, to any person obtaining a copy
4+
# of this software and associated documentation files (the "Software"), to deal
5+
# in the Software without restriction, including without limitation the rights
6+
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7+
# copies of the Software, and to permit persons to whom the Software is
8+
# furnished to do so, subject to the following conditions:
9+
10+
# The above copyright notice and this permission notice shall be included in all
11+
# copies or substantial portions of the Software.
12+
13+
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15+
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16+
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17+
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18+
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19+
# SOFTWARE.
20+
121
FROM python:buster
222

323
# Install Jupyter package and PowerShell "kernel" for Jupyter

README.md

Lines changed: 8 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,22 @@
1-
# jupyter-powershell
1+
# Docker Image for jupyter-powershell
22

3-
PowerShell language kernel for Jupyter.
4-
Works on Windows, Linux and MacOS.
3+
Dockerized PowerShell language kernel for Jupyter. Works on Linux and Docker Desktop.
54

6-
## Install kernel
5+
## Build Container Image
76

8-
```
9-
pip install powershell_kernel
10-
python -m powershell_kernel.install
11-
```
12-
13-
This command will install the kernel with Full PowerShell on Windows and Core on non-Windows.
14-
You can also specify command (i.e. if you want to use powershell Core on Windows).
7+
To build the container image, run the following command:
158

169
```
17-
python -m powershell_kernel.install --powershell-command pwsh
10+
docker build --tag jupyter-powershell .
1811
```
1912

20-
## Run
21-
22-
Run jupyter and you will see new kernel available!
13+
To run a container, run the following command:
2314

2415
```
25-
jupyter notebook
16+
docker run --interactive --tty --publish 8080:8080 jupyter-powershell
2617
```
2718

28-
## Aknowledgement
19+
## Acknowledgement
2920

3021
This is an early prototype, but I tried to avoid unnessesary dependencies.
3122

@@ -44,8 +35,3 @@ This means that, although the parts of SublimeREPL that I (wuub) wrote are publi
4435
I'd like to avoid GPLv2 dependencies (and I don't need any of that code), so I want to list all used code (BSD/MIT):
4536

4637
* `subprocess_repl.py` wrote by wuub, licensed under BSD/MIT.
47-
48-
49-
### LICENSE
50-
51-
All code that I (vors) wrote is licensed under MIT v3 license.

0 commit comments

Comments
 (0)