xai-smiles 0.1.3
A Custom Jupyter Widget Library
License: BSD
Requires Python: >=3.6
Keywords: Jupyter,Widgets,IPython

# xai_smiles

[![Build Status](https://travis-ci.org/Bayer/xai_smiles.svg?branch=master)](https://travis-ci.org/Bayer/xai_smiles)
[![codecov](https://codecov.io/gh/Bayer/xai_smiles/branch/master/graph/badge.svg)](https://codecov.io/gh/Bayer/xai_smiles)

A Custom Jupyter Widget Library to visualize SMILES-based XAI explanations.

## Installation

You can install using `pip`:

```bash
pip install xai_smiles
```

If you are using Jupyter Notebook 5.2 or earlier, you may also need to enable
the nbextension:

```bash
jupyter nbextension enable --py [--sys-prefix|--user|--system] xai_smiles
```

## Development Installation

Create a dev environment:

```bash
conda create -n xai_smiles-dev -c conda-forge nodejs yarn python jupyterlab
conda activate xai_smiles-dev
pip install jupyter-packaging
```

Install the python. This will also build the TS package.

```bash
pip install -e ".[test, examples]"
```

When developing your extensions, you need to manually enable your extensions with the
notebook / lab frontend. For lab, this is done by the command:

```
jupyter labextension develop --overwrite .
yarn run build
```

For classic notebook, you need to run:

```
jupyter nbextension install --sys-prefix --symlink --overwrite --py xai_smiles
jupyter nbextension enable --sys-prefix --py xai_smiles
```

Note that the `--symlink` flag doesn't work on Windows, so you will here have to run
the `install` command every time that you rebuild your extension. For certain installations
you might also need another flag instead of `--sys-prefix`, but we won't cover the meaning
of those flags here.

### How to see your changes

#### Typescript:

If you use JupyterLab to develop then you can watch the source directory and run JupyterLab at the same time in different
terminals to watch for changes in the extension's source and automatically rebuild the widget.

```bash
# Watch the source directory in one terminal, automatically rebuilding when needed
yarn run watch
# Run JupyterLab in another terminal
jupyter lab
```

After a change wait for the build to finish and then refresh your browser and the changes should take effect.

#### Python:

If you make a change to the python code then you will need to restart the notebook kernel to have it take effect.

## Releasing your initial packages:

- Add tests
- Ensure tests pass locally and on CI. Check that the coverage is reasonable.
- Make a release commit, where you remove the `, 'dev'` entry in `_version.py` AND `_frontend.py`.
- Update the version in `package.json`
- Relase the npm packages:
  ```bash
  npm login
  npm publish
  ```
- Bundle the python package: `python setup.py sdist bdist_wheel`
- Publish the package to PyPI:
  ```bash
  pip install twine
  twine upload dist/<python package name>*
  ```
- Tag the release commit (`git tag <python package version identifier>`)
- Update the version in `_version.py`, and put it back to dev (e.g. 0.1.0 -> 0.2.0.dev).
  Update the versions of the npm packages (without publishing).
- Commit the changes.
- `git push` and `git push --tags`.

## Uninstall

- `jupyter labextension list`
- `pip uninstall xai_smiles`
- `rm -r <path-to:>/share/jupyter/labextensions/xai_smiles`