Skip to content

Commit

Permalink
docs: include testing during development
Browse files Browse the repository at this point in the history
  • Loading branch information
jnoortheen committed Mar 23, 2023
1 parent 013becb commit 259d915
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -131,3 +131,6 @@ dmypy.json

# no need for libraries to keep poetry.lock
poetry.lock

# test files
*.ipynb
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,31 @@ euporie-notebook --kernel-name xonsh # or change the kernel in UI
euporie-console --kernel-name xonsh # or change the kernel in UI
```

## Testing

- install the project with its dependencies
```bash
poetry install
poetry install --only-root
```
- now start the xonsh shell

```sh
xonsh --no-rc
```

- inside the xonsh shell, you can load the jupyter xontrib and install the kernel

```sh
xontrib load jupyter

# this will install the kernel
xonfig jupyter-kernel --user

# now start a notebook and choose xonsh kernel
jupyter notebook
```

## Releasing your package

1. Bump the version of the package `poetry version patch`
Expand Down

0 comments on commit 259d915

Please sign in to comment.