Skip to content

Commit

Permalink
📝 update instructions of packaging / installation / dev installation
Browse files Browse the repository at this point in the history
  • Loading branch information
jgunstone committed Jan 15, 2024
1 parent 5b0df69 commit d63fb15
Showing 1 changed file with 11 additions and 12 deletions.
23 changes: 11 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,23 +52,22 @@ for example it would be great to create a `RunSnake` app for executing SnakeMake

## Install

TODO: publish publicly and update the install commands below

- install from network channel

```bash
conda config --add channels file:///mnt/conda-bld
mamba install ipyrun
# or
mamba install -c file:///mnt/conda-bld ipyrun
pip install ipyrun
```

- install pip dependencies
## Develop

```bash
pip install mydocstring
mamba env create -f environment-dev.yml
pytest
```

## Build
## Packaging and Publish

- [conda-bld](docs/conda-bld.md)
```sh
# NOTE: restricted to core-maintainers only
mamba activate hatcher # or conda env with hatch installed
hatch build # builds to local folder
hatch publish -u __token__ -a <your-pypi-token> # publishes to pypi
```

0 comments on commit d63fb15

Please sign in to comment.