PyPI - labapi - Versions diffs - 1.0.3__tar.gz → 1.1.0__tar.gz - Mend

labapi 1.0.3tar.gz → 1.1.0tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (174) hide show

{labapi-1.0.3 → labapi-1.1.0}/.github/ISSUE_TEMPLATE/bug_report.yml RENAMED Viewed

@@ -30,6 +30,8 @@ body:
       label: Python version
       description: Which Python version reproduces the issue?
       options:
+        - "3.10"
+        - "3.11"
         - "3.12"
         - "3.13"
         - Other

{labapi-1.0.3 → labapi-1.1.0}/.github/workflows/docs.yml RENAMED Viewed

@@ -20,10 +20,10 @@ jobs:
           version: "latest"
       - name: Set up Python
-        run: uv python install 3.13
+        run: uv python install
       - name: Install dependencies
         run: uv sync --all-groups
       - name: Build Sphinx docs
-        run: uv run sphinx-build -b html docs/source docs/_build
+        run: uv run sphinx-build -b html docs/source docs/_build/html

{labapi-1.0.3 → labapi-1.1.0}/.github/workflows/format.yml RENAMED Viewed

@@ -10,4 +10,3 @@ jobs:
     with:
       job_name: Ruff format
       command: uv run ruff format --check .
-      python_versions: '["3.13"]'

{labapi-1.0.3 → labapi-1.1.0}/.github/workflows/integration_tests.yml RENAMED Viewed

@@ -27,7 +27,7 @@ jobs:
         version: "latest"
     - name: Set up Python
-      run: uv python install 3.13
+      run: uv python install 3.10
     - name: Install dependencies
       run: uv sync --all-groups

{labapi-1.0.3 → labapi-1.1.0}/.github/workflows/lint.yml RENAMED Viewed

@@ -10,4 +10,3 @@ jobs:
     with:
       job_name: Ruff lint
       command: uv run ruff check .
-      python_versions: '["3.13"]'

labapi-1.1.0/.github/workflows/pages.yml ADDED Viewed

@@ -0,0 +1,91 @@
+name: Pages
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+concurrency:
+  group: pages
+  cancel-in-progress: false
+jobs:
+  build:
+    name: Build docs site
+    runs-on: ubuntu-latest
+    env:
+      # Older release tags import typing.Self and typing.override.
+      UV_PYTHON: "3.12"
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+      - name: Configure GitHub Pages
+        uses: actions/configure-pages@v5
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+          version: "latest"
+      - name: Set up Python
+        run: uv python install
+      - name: Install dependencies
+        run: uv sync --all-groups
+      - name: Build versioned Sphinx docs
+        run: uv run sphinx-multiversion docs/source docs/_build/html
+      - name: Add Pages root files
+        run: |
+          set -eu
+          latest="$(find docs/_build/html -maxdepth 1 -mindepth 1 -type d -printf '%f\n' | grep -E '^v[0-9]+\.[0-9]+\.[0-9]+$' | sort -V | tail -n 1)"
+          if [ -z "$latest" ]; then
+            echo "No versioned docs directories found." >&2
+            exit 1
+          fi
+          touch docs/_build/html/.nojekyll
+          cat > docs/_build/html/index.html <<EOF
+          <!doctype html>
+          <html lang="en">
+          <head>
+            <meta charset="utf-8">
+            <meta http-equiv="refresh" content="0; url=./${latest}/index.html">
+            <link rel="canonical" href="./${latest}/index.html">
+            <title>Redirecting...</title>
+          </head>
+          <body>
+            <p>Redirecting to <a href="./${latest}/index.html">${latest}</a>.</p>
+          </body>
+          </html>
+          EOF
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v4
+        with:
+          path: docs/_build/html
+  deploy:
+    name: Deploy docs site
+    runs-on: ubuntu-latest
+    needs: build
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

{labapi-1.0.3 → labapi-1.1.0}/.github/workflows/publish.yml RENAMED Viewed

@@ -31,10 +31,10 @@ jobs:
           version: "latest"
       - name: Set up Python
-        run: uv python install 3.13
+        run: uv python install 3.10
       - name: Build distributions
-        run: uv build --python 3.13 --clear --no-build-logs
+        run: uv build --python 3.10 --clear --no-build-logs
       - name: Publish to PyPI
         run: uv publish --trusted-publishing always

{labapi-1.0.3 → labapi-1.1.0}/.github/workflows/python_check.yml RENAMED Viewed

@@ -16,7 +16,7 @@ on:
       python_versions:
         required: false
         type: string
-        default: '["3.12", "3.13"]'
+        default: '["3.10", "3.11", "3.12", "3.13"]'
 jobs:
   check:

{labapi-1.0.3 → labapi-1.1.0}/.gitignore RENAMED Viewed

@@ -11,7 +11,6 @@ wheels/
 .venv
 .env
-.python-version
 .ruff_cache/
 .mypy_cache/
@@ -52,4 +51,5 @@ docs/source/reference/generated/
 .ipynb-checkpoints
-.tmpdocs
+.tmpdocs
+.complexipy_cache/

labapi-1.1.0/.python-version ADDED Viewed

	@@ -0,0 +1 @@
1	+ 3.10

labapi-1.1.0/CHANGELOG.md ADDED Viewed

@@ -0,0 +1,99 @@
+# Changelog
+All notable changes to `labapi` are documented here in release order.
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+This changelog is written for package users and maintainers, so entries call
+out user-visible behavior, supported runtime changes, and release-engineering
+details that affect development workflows.
+## 1.1.0 - 2026-06-02
+### Added
+- `Attachment.from_file()` now accepts filesystem `str` or `Path` objects in
+  addition to file-like objects.
+- `Notebook.search()` for paginated LabArchives entry search results using
+  normal entry objects.
+- Support for escaped separators (`\/`) in notebook paths, enabling access to
+  and creation of notebook nodes with literal slashes in their names.
+- Official support for Python 3.10 and 3.11.
+- `typing-extensions` as a runtime dependency so code can use backported typing
+  helpers such as `Self`, `override`, and `Buffer` while supporting Python 3.10.
+- Lazy environment-variable loading through `labapi.util.env.getenv()`. When
+  `python-dotenv` is installed, `.env` is loaded on first credential lookup
+  instead of during `labapi.client` import.
+### Changed
+- Refactored the `json_sync` example into a reusable utility with
+  comprehensive tests.
+- Rewrote the `csv_table` example for improved clarity and usability.
+- Refactored the `folder_download` example into clearer reusable download
+  logic.
+- Reworked entry factory fallback handling. Unknown upstream LabArchives part
+  types now load as `UnknownEntry`, while recognized but unimplemented part
+  types load as `UnimplementedEntry`; both still reject unsupported updates.
+- Updated attachment cloning to use an explicit random-access capability check
+  instead of requiring every file-like object to expose a reliable
+  `seekable()` method.
+- Kept spooled attachment buffers open after `Attachment.from_file()` returns,
+  while still preserving the caller's original file cursor position.
+### Fixed
+- Fixed runtime typing in `Attachment.from_file()` to support both file-like
+  and path-like inputs correctly.
+- Improved `Attachment.from_file()` support for random-access binary streams
+  that do not expose `seekable()`.
+- Fixed relative path resolution bugs when using the `/` operator with absolute
+  and relative `NotebookPath` objects.
+## 1.0.3 - 2026-04-15
+### Changed
+- Refined the client auth flow and browser detection behavior.
+- Simplified tree path handling.
+- Switched the `1.0` type-check workflow from `mypy` to `ty`.
+- Refreshed package metadata, README content, and Zenodo configuration.
+- Updated `pillow` and `pytest`.
+### Fixed
+- Restored datetime-based URL signing support.
+- Improved browser detection robustness when detectable values arrive with
+  incorrect types.
+- Fixed test compatibility issues in the `1.0` maintenance branch.
+- Reduced tree creation complexity in the `v1.0.3` stabilization pass.
+## 1.0.2 - 2026-04-10
+### Changed
+- Cleaned up the PyPI README and related package metadata.
+## 1.0.1 - 2026-04-10
+### Added
+- Initial TestPyPI publishing workflow.
+- GitHub issue templates.
+- Reusable GitHub Actions checks and broader local tooling support.
+### Changed
+- Improved versioning and generated documentation metadata.
+- Refreshed contributor and Sphinx configuration docs.
+- Updated `cryptography`, `pygments`, and `requests`.
+## 1.0.0 - 2026-04-01
+### Added
+- Initial stable release of `labapi`.
+- Support for LabArchives authentication, notebook tree traversal, and
+  page and entry operations from Python.
+- Project documentation and example workflows for common notebook automation
+  tasks.

{labapi-1.0.3/src/labapi.egg-info → labapi-1.1.0}/PKG-INFO RENAMED Viewed

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: labapi
-Version: 1.0.3
+Version: 1.1.0
 Summary: A Python client for the LabArchives API.
 Author-email: Christoph Li <christoph.li@nih.gov>, Joshua Lawrimore <josh.lawrimore@nih.gov>
 License: CC0-1.0
-Project-URL: Documentation, https://github.com/nimh-dsst/labapi/tree/main/docs/source
+Project-URL: Documentation, https://nimh-dsst.github.io/labapi/
 Project-URL: Issues, https://github.com/nimh-dsst/labapi/issues
 Project-URL: Source, https://github.com/nimh-dsst/labapi
 Classifier: Development Status :: 5 - Production/Stable
@@ -15,6 +15,8 @@ Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: Implementation :: CPython
@@ -23,12 +25,13 @@ Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
-Requires-Python: >=3.12
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: cryptography>=46.0.3
 Requires-Dist: lxml>=6.0.2
 Requires-Dist: requests>=2.32.5
+Requires-Dist: typing-extensions>=4.12.2
 Provides-Extra: builtin-auth
 Requires-Dist: selenium>=4.39.0; extra == "builtin-auth"
 Requires-Dist: installed-browsers>=0.1.5; extra == "builtin-auth"
@@ -40,25 +43,26 @@ Dynamic: license-file
 A Python client for the LabArchives API.
-[![Python Version](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![Python Version](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
 [![Tests](https://github.com/nimh-dsst/labapi/actions/workflows/unit_tests.yml/badge.svg?branch=main)](https://github.com/nimh-dsst/labapi/actions/workflows/unit_tests.yml)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.19599400.svg)](https://doi.org/10.5281/zenodo.19599400)
 [![License: CC0-1.0](https://img.shields.io/badge/License-CC0_1.0-lightgrey.svg)](https://creativecommons.org/publicdomain/zero/1.0/)
 `labapi` helps you authenticate with LabArchives, navigate notebook trees, and create or update notebook content from Python.
-[Source](https://github.com/nimh-dsst/labapi) | [Docs](https://github.com/nimh-dsst/labapi/tree/main/docs/source) | [Issues](https://github.com/nimh-dsst/labapi/issues)
+[Source](https://github.com/nimh-dsst/labapi) | [Docs](https://nimh-dsst.github.io/labapi/) | [Issues](https://github.com/nimh-dsst/labapi/issues)
 ## Start Here
-- New to `labapi`? Follow the [First Success Tutorial](https://github.com/nimh-dsst/labapi/blob/main/docs/source/quick_start/tutorial.rst) for the fastest path from install to a visible change in LabArchives.
-- Already using `labapi`? Jump to the [Quick Start](https://github.com/nimh-dsst/labapi/blob/main/docs/source/quick_start/index.rst), [User Guide](https://github.com/nimh-dsst/labapi/blob/main/docs/source/guide/index.rst), [Examples](https://github.com/nimh-dsst/labapi/blob/main/docs/source/examples/index.rst), or [FAQ](https://github.com/nimh-dsst/labapi/blob/main/docs/source/faq.rst).
+- New to `labapi`? Follow the [First Success Tutorial](https://nimh-dsst.github.io/labapi/quick_start/tutorial.html) for the fastest path from install to a visible change in LabArchives.
+- Already using `labapi`? Jump to the [Quick Start](https://nimh-dsst.github.io/labapi/quick_start/index.html), [User Guide](https://nimh-dsst.github.io/labapi/guide/index.html), [Examples](https://nimh-dsst.github.io/labapi/examples/index.html), or [FAQ](https://nimh-dsst.github.io/labapi/faq.html).
 - Working on the package itself? Start with [CONTRIBUTING.md](https://github.com/nimh-dsst/labapi/blob/main/CONTRIBUTING.md).
 ## Install
 Requirements:
-- Python 3.12+
+- Python 3.10+
 - `uv` (recommended) or `pip`
 Recommended install for local use:
@@ -176,12 +180,12 @@ page = notebook.traverse("Experiments/2026/Results")
 ## Documentation Map
-- [First Success Tutorial](https://github.com/nimh-dsst/labapi/blob/main/docs/source/quick_start/tutorial.rst): shortest path from install to a successful write.
-- [Quick Start](https://github.com/nimh-dsst/labapi/blob/main/docs/source/quick_start/index.rst): setup, navigation, page creation, uploads, and basic write operations.
-- [Authentication Guide](https://github.com/nimh-dsst/labapi/blob/main/docs/source/guide/auth.rst): local browser auth, manual flows, and callback-based integration patterns.
-- [User Guide](https://github.com/nimh-dsst/labapi/blob/main/docs/source/guide/index.rst): paths, entries, API behavior, exceptions, limits, and architecture notes.
-- [Examples](https://github.com/nimh-dsst/labapi/blob/main/docs/source/examples/index.rst): end-to-end scripts for real workflows.
-- [FAQ](https://github.com/nimh-dsst/labapi/blob/main/docs/source/faq.rst): troubleshooting and environment questions.
+- [First Success Tutorial](https://nimh-dsst.github.io/labapi/quick_start/tutorial.html): shortest path from install to a successful write.
+- [Quick Start](https://nimh-dsst.github.io/labapi/quick_start/index.html): setup, navigation, page creation, uploads, and basic write operations.
+- [Authentication Guide](https://nimh-dsst.github.io/labapi/guide/auth.html): local browser auth, manual flows, and callback-based integration patterns.
+- [User Guide](https://nimh-dsst.github.io/labapi/guide/index.html): paths, entries, API behavior, exceptions, limits, and architecture notes.
+- [Examples](https://nimh-dsst.github.io/labapi/examples/index.html): end-to-end scripts for real workflows.
+- [FAQ](https://nimh-dsst.github.io/labapi/faq.html): troubleshooting and environment questions.
 ## Development

{labapi-1.0.3 → labapi-1.1.0}/README.md RENAMED Viewed

@@ -2,25 +2,26 @@
 A Python client for the LabArchives API.
-[![Python Version](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![Python Version](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
 [![Tests](https://github.com/nimh-dsst/labapi/actions/workflows/unit_tests.yml/badge.svg?branch=main)](https://github.com/nimh-dsst/labapi/actions/workflows/unit_tests.yml)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.19599400.svg)](https://doi.org/10.5281/zenodo.19599400)
 [![License: CC0-1.0](https://img.shields.io/badge/License-CC0_1.0-lightgrey.svg)](https://creativecommons.org/publicdomain/zero/1.0/)
 `labapi` helps you authenticate with LabArchives, navigate notebook trees, and create or update notebook content from Python.
-[Source](https://github.com/nimh-dsst/labapi) | [Docs](https://github.com/nimh-dsst/labapi/tree/main/docs/source) | [Issues](https://github.com/nimh-dsst/labapi/issues)
+[Source](https://github.com/nimh-dsst/labapi) | [Docs](https://nimh-dsst.github.io/labapi/) | [Issues](https://github.com/nimh-dsst/labapi/issues)
 ## Start Here
-- New to `labapi`? Follow the [First Success Tutorial](https://github.com/nimh-dsst/labapi/blob/main/docs/source/quick_start/tutorial.rst) for the fastest path from install to a visible change in LabArchives.
-- Already using `labapi`? Jump to the [Quick Start](https://github.com/nimh-dsst/labapi/blob/main/docs/source/quick_start/index.rst), [User Guide](https://github.com/nimh-dsst/labapi/blob/main/docs/source/guide/index.rst), [Examples](https://github.com/nimh-dsst/labapi/blob/main/docs/source/examples/index.rst), or [FAQ](https://github.com/nimh-dsst/labapi/blob/main/docs/source/faq.rst).
+- New to `labapi`? Follow the [First Success Tutorial](https://nimh-dsst.github.io/labapi/quick_start/tutorial.html) for the fastest path from install to a visible change in LabArchives.
+- Already using `labapi`? Jump to the [Quick Start](https://nimh-dsst.github.io/labapi/quick_start/index.html), [User Guide](https://nimh-dsst.github.io/labapi/guide/index.html), [Examples](https://nimh-dsst.github.io/labapi/examples/index.html), or [FAQ](https://nimh-dsst.github.io/labapi/faq.html).
 - Working on the package itself? Start with [CONTRIBUTING.md](https://github.com/nimh-dsst/labapi/blob/main/CONTRIBUTING.md).
 ## Install
 Requirements:
-- Python 3.12+
+- Python 3.10+
 - `uv` (recommended) or `pip`
 Recommended install for local use:
@@ -138,12 +139,12 @@ page = notebook.traverse("Experiments/2026/Results")
 ## Documentation Map
-- [First Success Tutorial](https://github.com/nimh-dsst/labapi/blob/main/docs/source/quick_start/tutorial.rst): shortest path from install to a successful write.
-- [Quick Start](https://github.com/nimh-dsst/labapi/blob/main/docs/source/quick_start/index.rst): setup, navigation, page creation, uploads, and basic write operations.
-- [Authentication Guide](https://github.com/nimh-dsst/labapi/blob/main/docs/source/guide/auth.rst): local browser auth, manual flows, and callback-based integration patterns.
-- [User Guide](https://github.com/nimh-dsst/labapi/blob/main/docs/source/guide/index.rst): paths, entries, API behavior, exceptions, limits, and architecture notes.
-- [Examples](https://github.com/nimh-dsst/labapi/blob/main/docs/source/examples/index.rst): end-to-end scripts for real workflows.
-- [FAQ](https://github.com/nimh-dsst/labapi/blob/main/docs/source/faq.rst): troubleshooting and environment questions.
+- [First Success Tutorial](https://nimh-dsst.github.io/labapi/quick_start/tutorial.html): shortest path from install to a successful write.
+- [Quick Start](https://nimh-dsst.github.io/labapi/quick_start/index.html): setup, navigation, page creation, uploads, and basic write operations.
+- [Authentication Guide](https://nimh-dsst.github.io/labapi/guide/auth.html): local browser auth, manual flows, and callback-based integration patterns.
+- [User Guide](https://nimh-dsst.github.io/labapi/guide/index.html): paths, entries, API behavior, exceptions, limits, and architecture notes.
+- [Examples](https://nimh-dsst.github.io/labapi/examples/index.html): end-to-end scripts for real workflows.
+- [FAQ](https://nimh-dsst.github.io/labapi/faq.html): troubleshooting and environment questions.
 ## Development

labapi 1.0.3__tar.gz → 1.1.0__tar.gz

labapi 1.0.3tar.gz → 1.1.0tar.gz