diff --git a/.github/workflows/prepare_release.yml b/.github/workflows/prepare_release.yml index f126105..cf92a2a 100644 --- a/.github/workflows/prepare_release.yml +++ b/.github/workflows/prepare_release.yml @@ -93,7 +93,7 @@ jobs: import os, sys, urllib.error, urllib.request new = os.environ["NEW"] - url = f"https://pypi.org/pypi/emdatabase/{new}/json" + url = f"https://pypi.org/pypi/em-database/{new}/json" try: urllib.request.urlopen(url, timeout=30) except urllib.error.HTTPError as error: @@ -105,7 +105,7 @@ jobs: print(f"::warning::could not reach PyPI ({error.reason}), skipping the check") sys.exit(0) sys.exit( - f"emdatabase {new} is already on PyPI. A version can only ever be " + f"em-database {new} is already on PyPI. A version can only ever be " f"uploaded once, so pick a higher one." ) PY diff --git a/README.md b/README.md index b612d86..46143b2 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,9 @@ A list of all datasets and model weights can be found in our [docs](https://elec ## Installation ```bash -pip install emdatabase +pip install em-database ``` -You can install `emdatabase` via pip or as a local install in the usual way. +You can install `em-database` via pip or as a local install in the usual way. The distribution is named `em-database` on PyPI; the import name is `emdatabase`. ## Usage diff --git a/emdatabase/__init__.py b/emdatabase/__init__.py index 2e61e72..7632e08 100644 --- a/emdatabase/__init__.py +++ b/emdatabase/__init__.py @@ -11,7 +11,7 @@ def browse(**kwargs): Returns an `anywidget` widget listing every dataset grouped by technique, showing which are downloaded, revealing full metadata on hover, and downloading on click with a live progress bar. Requires the optional - `anywidget` dependency (`pip install emdatabase[widget]`). + `anywidget` dependency (`pip install em-database[widget]`). ``display(emdatabase)`` renders the same browser. """ @@ -51,7 +51,7 @@ def _repr_mimebundle_(self, include=None, exclude=None, **kwargs): return { "text/plain": ( "emdatabase — install the interactive browser with " - "`pip install emdatabase[widget]`, then call " + "`pip install em-database[widget]`, then call " "emdatabase.browse()." ) } diff --git a/emdatabase/widget.py b/emdatabase/widget.py index 470cf0e..0fb0f9f 100644 --- a/emdatabase/widget.py +++ b/emdatabase/widget.py @@ -347,7 +347,7 @@ def card(dataset): """Return an interactive card widget for a single dataset (Jupyter). This backs ``display(dataset)`` / a dataset being the last line in a cell. - Requires anywidget (``pip install emdatabase[widget]``). + Requires anywidget (``pip install em-database[widget]``). """ _prepare_frontend() try: @@ -355,7 +355,7 @@ def card(dataset): except ImportError as error: raise ImportError( "Displaying a dataset needs anywidget. Install it with " - "`pip install emdatabase[widget]` (or `pip install anywidget`)." + "`pip install em-database[widget]` (or `pip install anywidget`)." ) from error return cls(dataset) @@ -363,7 +363,7 @@ def card(dataset): def browse(**kwargs): """Return an interactive dataset browser widget for Jupyter. - Requires anywidget (``pip install emdatabase[widget]``). The widget lists + Requires anywidget (``pip install em-database[widget]``). The widget lists every dataset grouped by technique, shows which are downloaded, reveals full metadata on hover, and downloads on click with a live progress bar. """ @@ -373,7 +373,7 @@ def browse(**kwargs): except ImportError as error: raise ImportError( "emdatabase.browse() needs anywidget. Install it with " - "`pip install emdatabase[widget]` (or `pip install anywidget`)." + "`pip install em-database[widget]` (or `pip install anywidget`)." ) from error return cls(**kwargs) diff --git a/pyproject.toml b/pyproject.toml index 3bddf52..698158a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,5 +1,5 @@ [project] -name = "emdatabase" +name = "em-database" version = "0.5.0" description = "A database for electron microscopy data using pooch to download and manage files." readme = "README.md"