Skip to content

Commit

Permalink
adds instructions about creating a .whl package
Browse files Browse the repository at this point in the history
Signed-off-by: Christian Biasuzzi <[email protected]>
  • Loading branch information
CBiasuzzi committed Mar 1, 2024
1 parent 4eaba7e commit 821f181
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Widgets for [pypowsybl](https://github.com/powsybl/pypowsybl) in the Jupyter not

## Installation

You can install using `pip`:
You can install pypowsybl-jupyter using `pip`:

```bash
pip install pypowsybl_jupyter
Expand Down Expand Up @@ -35,6 +35,21 @@ Install the python. This will also build the TS package.
pip install -e ".[test]"
```

## Packaging for distribution

To package pypowsybl-jupyter in a .whl file, for distribution:
```bash
conda activate pypowsybl_jupyter-dev
pip install build
pip install -e ".[test]"
python -m build .
```

The 'created .whl file' will be available in the 'dist' directory. To install the .whl file:
```bash
pip install <'created .whl file'>
```


### Note

Expand Down

0 comments on commit 821f181

Please sign in to comment.