Skip to content

Commit

Permalink
docs: add publishing instructions for widget and add pypi badge
Browse files Browse the repository at this point in the history
  • Loading branch information
domoritz committed Aug 4, 2023
1 parent 0944b74 commit 1590456
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion packages/widget/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Mosaic Widget

[![PyPi](https://img.shields.io/pypi/v/mosaic-widget.svg)](https://pypi.org/project/mosaic-widget/)

A Jupyter Widget for Mosaic. Create interactive Mosaic plots over Pandas and Polars data frames or DuckDB connections.

Learn how to install and use the widget in the [Mosaic documentation](https://uwdata.github.io/mosaic/jupyter/).
Expand All @@ -18,4 +20,4 @@ Run `npm run build` to build the widget JavaScript code. If you want to live edi

## Publishing

First, make sure that you set `_DEV = False`. Run the build with `npm run build` and `hatch build`. Then publish with `hatch publish`.
First, make sure that you set `_DEV = False`. Run the build with `npm run build` and `hatch build`. Then publish with `hatch publish`. We publish using tokens so when asked, set the username to `__token__` and then use your token as the password.

0 comments on commit 1590456

Please sign in to comment.