@@ -20,7 +20,7 @@ This kernel is installable via Python's package installer, [pip](https://pip.pyp
20
20
In your terminal, run the follwing command:
21
21
22
22
``` sh
23
- pip install dyalog_jupyter_kernel
23
+ pip install dyalog-jupyter-kernel[ == 2.0.0]
24
24
```
25
25
26
26
After successfully installing the kernel module itself, you need to register it with your Jupyter installation, using the following terminal command:
@@ -45,12 +45,56 @@ jupyter lab # or jupyter notebook
45
45
```
46
46
and you should now see Dyalog APL amongst your kernels. Click on the Dyalog APL icon.
47
47
48
- ## Build notes (internal interest only)
48
+ ## Build notes (kernel developer interest only)
49
49
50
50
Build release assets with
51
51
52
52
``` sh
53
53
python setup.py sdist bdist_wheel
54
54
```
55
55
56
- Upload release assets using ` twine ` .
56
+ Built assets will end up in ` dist/ ` , and you can instruct ` pip ` to install from file for testing:
57
+
58
+ ``` sh
59
+ pip install dist/dyalog-jupyter-kernel-x.y.z.tar.gz
60
+ ```
61
+
62
+ Upload release assets using [ twine] ( https://twine.readthedocs.io/en/stable/ ) . Install ` twine ` with
63
+
64
+ ``` sh
65
+ pip install twine
66
+ ```
67
+
68
+ Pick up the API token, and set up your ` $HOME/.pypirc ` file like this:
69
+
70
+ ```
71
+ [distutils]
72
+ index-servers =
73
+ pypi
74
+ testpypi
75
+
76
+ [pypi]
77
+ username = __token__
78
+ password = pypi-A...Z # Replace with your actual PyPI API token
79
+
80
+ [testpypi]
81
+ repository = https://test.pypi.org/legacy/
82
+ username = __token__
83
+ password = pypi-A...Z # Replace with your actual TestPyPI API token
84
+ ```
85
+
86
+ Use the API key as password, including the ` pypi- ` prefix.
87
+
88
+ Upload the release:
89
+
90
+ ``` sh
91
+ twine upload --repository [test]pypi dist/*
92
+ ```
93
+
94
+ To install the module from the test index, use
95
+
96
+ ``` sh
97
+ pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple dyalog-jupyter-kernel[== 2.0.0]
98
+ python -m ' dyalog_kernel' install
99
+ ```
100
+ The ` --extra-index-url ` argument is there so that ` pip ` can pick up any dependencies from the main index.
0 commit comments