docput 0.2.1__tar.gz → 1.0.1__tar.gz

{docput-0.2.1 → docput-1.0.1}/.forgejo/workflows/push.yml

@@ -1,10 +1,16 @@
 name: build
 on: [ push, pull_request ]
+concurrency:
+  group: drewcassidy.me/docput ${{ forge.event_name }}
+  cancel-in-progress: false
 
 jobs:
-  build:
-    name: Test & Build
-    runs-on: ubuntu-24.04
+  test:
+    name: Test on Python ${{ matrix.python-version }}
+    runs-on: ubuntu-26.04
+    strategy:
+      matrix:
+        python-version: [ "3.14", "3.15" ]
     services:
       gitpages:
         image: codeberg.org/git-pages/git-pages:0.9.1
@@ -19,11 +25,13 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Set up Project
-        uses: https://git.offworld.city/actions/setup-python-project@87a134c2c5e6c03139c4215575f0f1ebdfcb41a2
+      - name: Set up Python
+        uses: https://code.forgejo.org/actions/setup-python@v6
         with:
-          python-version-file: pyproject.toml
-          pip-install: --editable . --group dev
+          python-version: ${{ matrix.python-version }}
+
+      - name: Set up Project
+        run: pip install --editable . --group dev
 
       - name: Lint
         run: just -v lint
@@ -31,20 +39,11 @@ jobs:
       - name: Test
         run: just -v test
 
-      - name: Build
-        run: just -v build
-
-      - name: Upload dist
-        uses: https://code.forgejo.org/forgejo/upload-artifact@v4
-        with:
-          name: python-dist
-          path: dist/
-          compression-level: 0 # already compressed
-
-
   document:
     name: Document
-    runs-on: ubuntu-24.04
+    needs:
+      - test
+    runs-on: ubuntu-26.04
     container:
       env:
         DOCPUT_REMOTE: git-pages+https://drewcassidy.me/docput
@@ -53,11 +52,13 @@ jobs:
       - name: Checkout
         uses: https://code.forgejo.org/actions/checkout@v5
 
-      - name: Set up Project
-        uses: https://git.offworld.city/actions/setup-python-project@87a134c2c5e6c03139c4215575f0f1ebdfcb41a2
+      - name: Set up Python
+        uses: https://code.forgejo.org/actions/setup-python@v6
         with:
           python-version-file: pyproject.toml
-          pip-install: --editable . --group docs
+
+      - name: Set up Project
+        run: pip install --editable . --group docs
 
       - name: Build docs
         run: just -v docs build -D version=${{ forge.ref_name }}
@@ -75,18 +76,15 @@ jobs:
     name: Publish
     if: forge.event_name == 'push' && startsWith(forge.ref, 'refs/tags')
     needs:
-      - build
+      - test
       - document
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-26.04
     steps:
       - name: Checkout
         uses: https://code.forgejo.org/actions/checkout@v5
 
-      - name: Download dist
-        uses: https://code.forgejo.org/forgejo/download-artifact@v4
-        with:
-          name: python-dist
-          path: dist
+      - name: Build dist
+        run: just -v build
 
       - name: Get Changelog Information
         id: yaclog-show

{docput-0.2.1 → docput-1.0.1}/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file
 
+## 1.0.1 - 2026-10-19
+
+### Fixed
+
+- Fixed error with trailing slashes in paths when using the git-pages backend on Python 3.15 (#4)
+
+
+## 1.0.0 - 2026-08-23
+
+### Changed
+
+- Reversed display order of versions in dropdown menu, so most recent versions are at the top
+
+
 ## 0.2.1 - 2026-07-30
 
 ### Fixed

{docput-0.2.1 → docput-1.0.1}/Justfile

@@ -2,16 +2,18 @@
 
 mod docs
 
+source_dirs := "src/ tests/"
+
 # Lint python source code
 lint:
-    pyflakes docput/
-    black --quiet --check docput/
-    zuban check docput/
+    pyflakes {{ source_dirs }}
+    black --quiet --check {{ source_dirs }}
+    zuban check {{ source_dirs }}
 
 # Format python source code and other support files
 format: && docs::format
-    black --quiet docput/
-    mdformat README.md CHANGELOG.md
+    black --quiet {{ source_dirs }}
+    mdformat README.md
     {{ just_executable() }} --fmt --unstable
 
 # Run tests
@@ -20,7 +22,7 @@ test *args:
 
 # Build distribution
 build:
-    python -m build
+    pipx run build
 
 pre-commit := f"""
   #!/bin/sh

{docput-0.2.1 → docput-1.0.1}/PKG-INFO

@@ -1,20 +1,26 @@
 Metadata-Version: 2.4
 Name: docput
-Version: 0.2.1
+Version: 1.0.1
 Summary: Deploy multi-versioned docs to static hosting
 Author-email: Andrew Cassidy <drewcassidy@me.com>
 License-Expression: MIT
 Project-URL: Source, https://git.offworld.city/drewcassidy/docput
+Project-URL: Documentation, https://drewcassidy.me/docput/latest/
 Keywords: sphinx,git-pages,documentation,ci
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: OS Independent
+Classifier: Environment :: Console
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: JavaScript
 Classifier: Topic :: Utilities
 Classifier: Topic :: Documentation
 Classifier: Topic :: Documentation :: Sphinx
+Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
+Classifier: Topic :: Software Development :: Documentation
 Classifier: Framework :: Sphinx
+Classifier: Framework :: Sphinx :: Extension
 Requires-Python: >=3.14
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
@@ -59,3 +65,12 @@ $ pip install docput
 [documentation]: https://drewcassidy.me/docput/latest/
 [pypi]: https://pypi.org/project/docput
 [source]: https://git.offworld.city/drewcassidy/docput
+
+## Licensing
+
+Docput is distributed under [the MIT license](LICENSE.md)
+
+Note that we *do not* waive the attribution requirements of our
+licenses, including for ingestion into machine learning models. If you
+train on and produce code derived from our work, you must uphold all
+attribution requirements in produced works.

{docput-0.2.1 → docput-1.0.1}/README.md

@@ -34,3 +34,12 @@ $ pip install docput
 [documentation]: https://drewcassidy.me/docput/latest/
 [pypi]: https://pypi.org/project/docput
 [source]: https://git.offworld.city/drewcassidy/docput
+
+## Licensing
+
+Docput is distributed under [the MIT license](LICENSE.md)
+
+Note that we *do not* waive the attribution requirements of our
+licenses, including for ingestion into machine learning models. If you
+train on and produce code derived from our work, you must uphold all
+attribution requirements in produced works.

{docput-0.2.1 → docput-1.0.1}/docs/Justfile

@@ -11,16 +11,13 @@ format:
 sphinx_module := "sphinx"
 
 # Build documentation.
-[arg("args", help="Arguments passed to sphinx")]
 build *args:
     python -m {{ sphinx_module }} . _build {{ args }}
 
 # Push documentation version
-[arg("args", help="Arguments passed to docput")]
 push *args:
     docput version push {{ args }} _build
 
 # Update root files for the documentation site
-[arg("args", help="Arguments passed to docput")]
 update-root *args:
     docput upload --merge _root . {{ args }}

{docput-0.2.1 → docput-1.0.1}/docs/_templates/page.html

@@ -2,5 +2,6 @@
 
 {% block site_meta %}
     <link rel="vcs-git" href="https://git.offworld.city/drewcassidy/docput.git"/>
+    <link rel="canonical" href="https://drewcassidy.me/docput/latest/{{ pagename }}{{ file_suffix }}"/>
     {{ super() }}
 {% endblock %}

{docput-0.2.1 → docput-1.0.1}/docs/commands/index.md

@@ -1,4 +1,4 @@
-# Command Reference
+# Commands
 
 ```{eval-rst}
 .. click:: docput.cli:main

{docput-0.2.1 → docput-1.0.1}/docs/index.md

@@ -15,6 +15,7 @@ start-after: <!-- begin-pitch -->
 ---
 hidden:
 ---
-getting_started
+installation
+user_guide
 commands/index
 ```

docput-1.0.1/docs/installation.md

@@ -0,0 +1,83 @@
+# Installation
+
+Install using pip
+
+```{code-block} console
+$ pip install docput
+```
+
+or by adding it as a documentation dependency for your python project
+
+```{code-block} toml
+---
+caption: pyproject.toml
+---
+[dependency-groups]
+docs = [
+    "docput",
+]
+```
+
+then install with
+
+```{code-block} console
+$ pip install --group docs
+```
+
+## Setup
+
+docput can be used as a standalone CLI tool
+with no additional setup,
+however it includes some tools
+to make navigating your documentation easier
+
+### Sphinx
+
+docput includes a sphinx extension
+to add a version selector to your documentation.
+The extension loads a small JavaScript file that reads the version manifest,
+so the menu is always up to date with the currently available versions.
+
+To use this menu,
+first add `docput` to the list of sphinx extensions in `conf.py`
+then add docput's templates folder to the search path.
+
+```{code-block} python
+---
+caption: conf.py
+---
+import docput
+
+extensions = [
+    "docput",
+]
+
+
+```
+
+Now, add the template path,
+and include the version selector
+in the list of sidebar elements.
+Consult your theme's documentation
+for [sidebar customization](inv:sphinx:std:confval#html_sidebars).
+The below example is for [Furo]
+
+```{code-block} python
+---
+emphasize-lines: 5
+caption: conf.py
+---
+templates_path = [docput.sphinx_templates, "_templates"]
+
+html_sidebars = {
+    "**": [
+        "sidebar/scroll-start.html",
+        "sidebar/brand.html",
+        "sidebar/version-switch.html", # provided by docput
+        "sidebar/search.html",
+        "sidebar/navigation.html",
+        "sidebar/scroll-end.html",
+    ]
+}
+```
+[furo]: https://github.com/pradyunsg/furo

docput-0.2.1/docs/getting_started.md → docput-1.0.1/docs/user_guide.md

@@ -1,83 +1,4 @@
-# Getting Started
-
-## Installation
-
-Install using pip
-
-```{code-block} console
-$ pip install docput
-```
-
-or by adding it as a documentation dependency for your python project
-
-```{code-block} toml
----
-caption: pyproject.toml
----
-[dependency-groups]
-docs = [
-    "docput",
-]
-```
-
-then install with
-
-```{code-block} console
-$ pip install --group docs
-```
-
-## Setup
-
-docput can be used as a standalone CLI tool
-with no additional setup,
-however it includes some tools
-to make navigating your documentation easier
-
-### Sphinx
-
-docput includes a sphinx extension
-to add a version selector to your documentation.
-The extension loads a small JavaScript file that reads the version manifest,
-so the menu is always up to date with the currently available versions.
-
-To use this menu,
-first add `docput` to the list of sphinx extensions in `conf.py`
-then add docput's templates folder to the search path.
-
-```{code-block} python
----
-caption: conf.py
----
-import docput
-
-extensions = [
-    "docput",
-]
-
-templates_path = [docput.sphinx_templates, "_templates"]
-```
-
-Finally, add the version selector to the list of sidebar elements.
-Consult your theme's documentation
-for [sidebar customization](inv:sphinx:std:confval#html_sidebars).
-The below example is for [Furo]
-
-```{code-block} python
----
-emphasize-lines: 5
-caption: conf.py
----
-html_sidebars = {
-    "**": [
-        "sidebar/scroll-start.html",
-        "sidebar/brand.html",
-        "sidebar/version-switch.html", # provided by docput
-        "sidebar/search.html",
-        "sidebar/navigation.html",
-        "sidebar/scroll-end.html",
-    ]
-}
-```
+# User Guide
 
 ## Connecting to a Remote
 
@@ -186,6 +107,6 @@ with {option}`--alias <docput version push --alias>`.
 is a shortcut for
 `--alias latest`.
 
-[furo]: https://github.com/pradyunsg/furo
+
 [git-pages]: https://git-pages.org
 [git-pages auth]: https://codeberg.org/git-pages/git-pages#authorization

{docput-0.2.1 → docput-1.0.1}/pyproject.toml

@@ -14,15 +14,20 @@ authors = [{ name = "Andrew Cassidy", email = "drewcassidy@me.com" }]
 license = "MIT"
 keywords = ["sphinx", "git-pages", "documentation", "ci"]
 classifiers = [
-    "Development Status :: 3 - Alpha",
+    "Development Status :: 5 - Production/Stable",
     "Intended Audience :: Developers",
     "Operating System :: OS Independent",
+    "Environment :: Console",
     "Programming Language :: Python :: 3 :: Only",
     "Programming Language :: Python :: 3",
+    "Programming Language :: JavaScript",
     "Topic :: Utilities",
     "Topic :: Documentation",
     "Topic :: Documentation :: Sphinx",
-    "Framework :: Sphinx"
+    "Topic :: Internet :: WWW/HTTP :: Site Management",
+    "Topic :: Software Development :: Documentation",
+    "Framework :: Sphinx",
+    "Framework :: Sphinx :: Extension",
 ]
 
 requires-python = ">= 3.14"
@@ -35,31 +40,32 @@ dynamic = ["version"]
 
 [dependency-groups]
 docs = [
-    "Sphinx ~= 9.1.0",
-    "furo ~= 2025.12.19",
-    "sphinx-inline-tabs ~= 2025.12.21.14",
-    "sphinx-copybutton ~= 0.5.2",
-    "sphinx-click ~= 6.2.0",
-    "myst-parser ~= 5.1.0"
+    "Sphinx ~= 9.1",
+    "furo == 2025.12.19",
+    "sphinx-inline-tabs == 2025.12.21.14",
+    "sphinx-copybutton ~= 0.5",
+    "sphinx-click ~= 6.2",
+    "myst-parser ~= 5.1"
 ]
 dev = [
     # format
-    "black ~= 26.3.1",
+    "black == 26.3.1",
     "mdformat ~= 1.0.0",
     "mdformat-config",
     "mdformat-black",
     "mdformat-myst",
     # lint
-    "pyflakes ~= 3.4.0",
-    "zuban ~= 0.9.0",
+    "pyflakes ~= 3.4",
+    "zuban ~= 0.10.0",
     # test
-    "pytest ~= 9.0.3",
+    "pytest ~= 9.0",
     # build
     "build",
 ]
 
 [project.urls]
 Source = "https://git.offworld.city/drewcassidy/docput"
+Documentation = "https://drewcassidy.me/docput/latest/"
 
 [project.scripts]
 docput = "docput.cli:main"
@@ -67,9 +73,6 @@ docput = "docput.cli:main"
 [tool.setuptools_scm]
 fallback_version = "0.0.0"
 
-[tool.setuptools.packages.find]
-include = ["docput*"]
-
 [tool.pytest]
 addopts = [
     '--doctest-modules',

{docput-0.2.1 → docput-1.0.1/src}/docput/cli/main.py

@@ -1,13 +1,12 @@
 import shutil
 import sys
+from functools import update_wrapper
 from io import Writer
 from pathlib import Path
 from typing import Any, Callable, Concatenate
-from functools import update_wrapper
 
 import click
 
-from ..protocols import Reader
 from ..remote import Remote, open_remote
 
 
@@ -65,7 +64,7 @@ def main_group(ctx: click.Context, remote: Remote):
 @pass_remote
 def download(remote: Remote, source: str, dest: Writer[bytes]):
     """Download SOURCE from the remote and write it to DEST"""
-    buff = remote.open_file(source)
+    buff = remote.open(source, "rb")
     shutil.copyfileobj(buff, dest)
 
 
@@ -84,7 +83,7 @@ def download(remote: Remote, source: str, dest: Writer[bytes]):
 def upload(
     remote: Remote,
     overwrite: bool,
-    source: Path | Reader[bytes],
+    source: Path,
     dest: str,
 ):
     """
@@ -99,8 +98,9 @@ def upload(
     """
     with remote:
         if isinstance(source, Path) and str(source) == "-":
-            source = sys.stdin.buffer
-        remote.write(source, dest, overwrite)
+            remote.write(sys.stdin.buffer.read(), dest)
+        else:
+            remote.copytree(source, dest, overwrite)
 
 
 @main_group.command(short_help="Delete a file or directory.")
@@ -109,7 +109,7 @@ def upload(
 def rm(remote: Remote, path: str):
     """Delete the file or directory at PATH on the remote"""
     with remote:
-        remote.delete(path)
+        remote.remove(path)
 
 
 @main_group.command(short_help="Create a symlink.")
@@ -117,9 +117,9 @@ def rm(remote: Remote, path: str):
 @click.argument("target")
 @pass_remote
 def ln(remote: Remote, source: str, target: str):
-    """Create a symlink on the remote at DEST pointing to SOURCE"""
+    """Create a symlink on the remote at TARGET pointing to SOURCE"""
     with remote:
-        remote.make_symlink(source, target)
+        remote.symlink(source, target)
 
 
 @main_group.command(short_help="Create a directory.")
@@ -128,4 +128,4 @@ def ln(remote: Remote, source: str, target: str):
 def mkdir(remote: Remote, path: str):
     """Create a directory on the remote at PATH. Any existing file or directory at PATH will be deleted"""
     with remote:
-        remote.make_dir(path)
+        remote.mkdir(path)

{docput-0.2.1 → docput-1.0.1/src}/docput/cli/manifest.py

@@ -1,11 +1,11 @@
 import os
-import shutil
 import subprocess
 from pathlib import Path
 from tempfile import TemporaryDirectory
 
 import click
 from click import ClickException
+from urlpath import URL
 
 from .main import main_group, pass_remote
 from ..config import get_config
@@ -29,6 +29,7 @@ def manifest_group(): ...
 @click.option(
     "--url",
     "url",
+    type=click.Path(path_type=URL),
     metavar="URL",
     help="""
          Set the root URL to a new value. The root URL is the base for all hrefs in the version manifest. This must be absolute (either a path starting
@@ -36,19 +37,22 @@ def manifest_group(): ...
          """,
 )
 @pass_remote
-def edit(remote: Remote, editor: str | None, url: str | None):
+def edit(remote: Remote, editor: str | None, url: URL | None):
     """Edit the version manifest."""
     with remote:
+        manifest = remote.read_manifest()
+        if url is not None:
+            manifest.base_url = url
         if editor is not None:
             with TemporaryDirectory() as td:
                 tmp_path = Path(td) / get_config().get("manifest_url")
-                with open(tmp_path, "wb") as temp:
-                    shutil.copyfileobj(remote.manifest.dump(), temp)
+                with open(tmp_path, "w") as temp:
+                    manifest.dump(temp)
                 while True:
                     subprocess.run([editor, tmp_path], check=True)
                     try:
-                        with open(tmp_path, "rb") as temp:
-                            remote.manifest = VersionManifest.read(temp)
+                        with open(tmp_path, "r") as temp:
+                            manifest = VersionManifest.load(temp)
                             return
                     except Exception as e:
                         retry = click.confirm(
@@ -58,5 +62,4 @@ def edit(remote: Remote, editor: str | None, url: str | None):
                             raise ClickException(
                                 f"Aborting after error parsing manifest file: {e}"
                             )
-        if url is not None:
-            remote.manifest.base_url = url
+        remote.write_manifest(manifest)