Merge pull request #74 from theislab/docs/pin-v0.1.4

docs: pin install instructions to v0.1.4

Author: timtreis

README.md

@@ -7,10 +7,10 @@ Lean read client for the spatialdata-db spatial-omics collection: query the cata
 ## Install
 
 ```bash
-pip install "spatialdata-db @ git+https://github.com/theislab/spatialdata-db-client@v0.1.3"
+pip install "spatialdata-db @ git+https://github.com/theislab/spatialdata-db-client@v0.1.4"
 ```
 
-This installs the alpha release, v0.1.3. The `main` branch may be ahead of it, and you get the newest code if you leave out `@v0.1.3`.
+This installs the alpha release, v0.1.4. The `main` branch may be ahead of it, and you get the newest code if you leave out `@v0.1.4`.
 
 ## Usage
 

docs/guides/cli-and-agents.md

@@ -5,7 +5,7 @@ The package installs two commands: `sddb-cli`, a thin command line over the cata
 same catalog.
 
 ```
-pip install "spatialdata-db @ git+https://github.com/theislab/spatialdata-db-client@v0.1.3"
+pip install "spatialdata-db @ git+https://github.com/theislab/spatialdata-db-client@v0.1.4"
 ```
 
 ## sddb-cli
@@ -122,7 +122,7 @@ A study without an entry in the published `citations.bib` gets a fallback entry
 The MCP server speaks stdio and exposes the catalog to an agent. Install the extra:
 
 ```
-pip install "spatialdata-db[mcp] @ git+https://github.com/theislab/spatialdata-db-client@v0.1.3"
+pip install "spatialdata-db[mcp] @ git+https://github.com/theislab/spatialdata-db-client@v0.1.4"
 ```
 
 ### Claude Desktop

docs/index.md

@@ -29,19 +29,19 @@ The `sddb-cli` command and the `sddb-mcp` server give the shell and AI agents th
 
 :::{tab-item} pip
 ```bash
-pip install "spatialdata-db @ git+https://github.com/theislab/spatialdata-db-client@v0.1.3"
+pip install "spatialdata-db @ git+https://github.com/theislab/spatialdata-db-client@v0.1.4"
 ```
 :::
 
 :::{tab-item} uv
 ```bash
-uv pip install "spatialdata-db @ git+https://github.com/theislab/spatialdata-db-client@v0.1.3"
+uv pip install "spatialdata-db @ git+https://github.com/theislab/spatialdata-db-client@v0.1.4"
 ```
 :::
 
 ::::
 
-This installs the alpha release, v0.1.3. The `main` branch may be ahead of it, and you get the newest code if you leave out `@v0.1.3`.
+This installs the alpha release, v0.1.4. The `main` branch may be ahead of it, and you get the newest code if you leave out `@v0.1.4`.
 
 The client needs Python 3.12 or newer. It is not on PyPI yet, so install it from GitHub.
 

docs/reference/mcp.md

@@ -3,7 +3,7 @@
 `sddb-mcp` serves the catalog to agents over stdio (Model Context Protocol). It needs the optional extra:
 
 ```bash
-pip install "spatialdata-db[mcp] @ git+https://github.com/theislab/spatialdata-db-client@v0.1.3"
+pip install "spatialdata-db[mcp] @ git+https://github.com/theislab/spatialdata-db-client@v0.1.4"
 sddb-mcp
 ```
 

docs/start.md

@@ -6,16 +6,16 @@ The [DB website]({{ site_url }}) is the place to find data. This page shows what
 ## Install
 
 ```bash
-pip install "spatialdata-db @ git+https://github.com/theislab/spatialdata-db-client@v0.1.3"
+pip install "spatialdata-db @ git+https://github.com/theislab/spatialdata-db-client@v0.1.4"
 ```
 
 or, with uv:
 
 ```bash
-uv pip install "spatialdata-db @ git+https://github.com/theislab/spatialdata-db-client@v0.1.3"
+uv pip install "spatialdata-db @ git+https://github.com/theislab/spatialdata-db-client@v0.1.4"
 ```
 
-This installs the alpha release, v0.1.3. The `main` branch may be ahead of it, and you get the newest code if you leave out `@v0.1.3`. The package needs Python 3.12 or newer. It is not on PyPI yet, so install it from GitHub. The name `sddb` on PyPI belongs to an unrelated package.
+This installs the alpha release, v0.1.4. The `main` branch may be ahead of it, and you get the newest code if you leave out `@v0.1.4`. The package needs Python 3.12 or newer. It is not on PyPI yet, so install it from GitHub. The name `sddb` on PyPI belongs to an unrelated package.
 
 The client keeps its cache in the user cache directory of the platform, in a folder called `sddb`. Set `SDDB_CACHE_DIR` to put it somewhere else, for example on a larger disk. The first call to `Catalog()` downloads the catalog (under 10 MB) from a GitHub release. Later calls check for a newer catalog and download it again only when one has been published.
 

docs/tutorials/00_overview.ipynb

@@ -21,7 +21,7 @@
     "tutorials use.\n",
     "\n",
     "```bash\n",
-    "pip install \"spatialdata-db[viz] @ git+https://github.com/theislab/spatialdata-db-client@v0.1.3\"\n",
+    "pip install \"spatialdata-db[viz] @ git+https://github.com/theislab/spatialdata-db-client@v0.1.4\"\n",
     "```\n",
     "\n",
     "The tutorials download about 50 MB of data in total, into the cache described in {doc}`02_load_and_inspect`.\n",

tests/test_docs_quickstart.py

@@ -8,7 +8,7 @@
 
 _ROOT = Path(__file__).parent.parent
 # The release the install instructions pin. To bump: replace the old tag in README.md and docs/, then change this line.
-ALPHA_TAG = "v0.1.3"
+ALPHA_TAG = "v0.1.4"
 
 
 def test_quickstart_api_exists():

tests/test_docs_reference.py

@@ -30,7 +30,14 @@ def test_mcp_page_lists_all_tools():
 
 def test_mcp_page_lists_tool_parameters():
     text = (REF / "mcp.md").read_text()
-    for fn in (tools.query_tool, tools.describe_tool, tools.genes_tool, tools.facets_tool, tools.cite_tool, tools.download_tool):
+    for fn in (
+        tools.query_tool,
+        tools.describe_tool,
+        tools.genes_tool,
+        tools.facets_tool,
+        tools.cite_tool,
+        tools.download_tool,
+    ):
         for param in inspect.signature(fn).parameters:
             if param in {"catalog_url", "bib_url", "workers", "facets"}:  # internal / not exposed by server.py
                 continue