Skip to content

Commit ab16a00

Browse files
committed
DOC: Install in virtual env
closes #36
1 parent 194498b commit ab16a00

File tree

1 file changed

+34
-5
lines changed

1 file changed

+34
-5
lines changed

README.md

Lines changed: 34 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# A Jupyter/IPython kernel for Gnuplot
22

3-
43
[![Release](https://img.shields.io/pypi/v/gnuplot_kernel.svg)](https://pypi.python.org/pypi/gnuplot_kernel)
54
[![License](https://img.shields.io/pypi/l/gnuplot_kernel.svg)](https://pypi.python.org/pypi/gnuplot_kernel)
65
[![Build Status](https://github.com/has2k1/plotnine/workflows/build/badge.svg?branch=main)](https://github.com/has2k1/plotnine/actions?query=branch%3Amain+workflow%3A%22build%22)
@@ -12,18 +11,48 @@ as `python` code.
1211

1312
## Installation
1413

15-
Official release
14+
It is good practice to install `gnuplot_kernel` in a virtual environment.
15+
We recommend using [uv](https://docs.astral.sh/uv/getting-started/installation/) or
16+
[python venv](https://docs.python.org/3/library/venv.html).
17+
18+
### Option 1: Using `uv`
1619

1720
```console
18-
$ pip install gnuplot_kernel
19-
$ python -m gnuplot_kernel install --user
21+
$ uv venv
2022
```
2123

24+
**Official release**
25+
26+
```console
27+
$ uv pip install gnuplot_kernel
28+
$ uv python -m gnuplot_kernel install --user
29+
```
2230

2331
The last command installs a kernel spec file for the current python installation. This
2432
is the file that allows you to choose a jupyter kernel in a notebook.
2533

26-
Development version
34+
**Development version**
35+
36+
37+
```console
38+
$ uv pip install git+https://github.com/has2k1/gnuplot_kernel.git@master
39+
$ uv python -m gnuplot_kernel install --user
40+
```
41+
42+
### Option 2: Using `python venv`
43+
44+
```console
45+
$ python3 -m venv .venv && source .venv/bin/activate
46+
```
47+
48+
**Official release**
49+
50+
```console
51+
$ pip install gnuplot_kernel
52+
$ python -m gnuplot_kernel install --user
53+
```
54+
55+
**Development version**
2756

2857
```console
2958
$ pip install git+https://github.com/has2k1/gnuplot_kernel.git@master

0 commit comments

Comments
 (0)