keepup-admin 0.1.0__tar.gz

keepup_admin-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

keepup_admin-0.1.0/NOTICE

@@ -0,0 +1,22 @@
+KeepUP — an admin framework over FastAPI
+Copyright 2026 Fedor Sergeev
+
+This product includes software developed by Fedor Sergeev.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+this file except in compliance with the License. You may obtain a copy of the
+License in the LICENSE file beside this one, or at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed
+under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.
+
+--------------------------------------------------------------------------------
+
+This package also ships five third-party front-end bundles, all under the MIT
+licence. They are minified, which stripped their own licence headers, so their
+notices travel in THIRD-PARTY.md beside this file. The Apache licence above does
+not reach them; they stay under their own terms.

keepup_admin-0.1.0/PKG-INFO

@@ -0,0 +1,117 @@
+Metadata-Version: 2.4
+Name: keepup-admin
+Version: 0.1.0
+Summary: An admin framework over FastAPI: plugins, panel, users, replicas
+Author-email: Fedor Sergeev <fksergeev@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/FedorSergeev/keepup-admin
+Project-URL: Repository, https://github.com/FedorSergeev/keepup-admin
+Keywords: fastapi,admin,plugins,framework
+Classifier: Framework :: FastAPI
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+License-File: THIRD-PARTY.md
+Requires-Dist: fastapi<1,>=0.128
+Requires-Dist: starlette<1,>=0.52
+Requires-Dist: pydantic<3,>=2.11
+Requires-Dist: sqlalchemy<3,>=2.0
+Requires-Dist: psycopg2-binary>=2.9
+Requires-Dist: apscheduler<4,>=3.10
+Requires-Dist: bcrypt<5,>=4.0
+Requires-Dist: python-jose<4,>=3.5
+Requires-Dist: python-multipart>=0.0.20
+Requires-Dist: PyYAML<7,>=6.0
+Requires-Dist: psutil>=7.0
+Requires-Dist: prometheus-client>=0.24
+Requires-Dist: requests>=2.31
+Requires-Dist: httpx>=0.28
+Provides-Extra: postgres
+Requires-Dist: asyncpg>=0.31; extra == "postgres"
+Dynamic: license-file
+
+# keepup
+
+An admin framework over FastAPI. You give it settings; it gives you an
+application with a panel, a plugin runtime, users, a database layer, an audit,
+metrics and coordination between replicas already wired.
+
+```python
+from keepup import KeepupSettings, create_app
+
+app = create_app(KeepupSettings(title="Your product", project_name="yours"))
+```
+
+That is a running application with a working panel at `/selfcare`: the shell,
+the themes and eight administrative sections ship inside the package, so there
+is nothing to copy into your tree to see them.
+
+Installed as `keepup-admin`; imported as `keepup`. The name `keepup` on PyPI
+belongs to an unrelated project from 2015 that installs a script and no module,
+so the import name is free.
+
+## What it gives you
+
+| | |
+|---|---|
+| **Application assembly** | `create_app(settings)` — FastAPI, middleware, lifespan, static mounts |
+| **Plugin runtime** | features as plugins; routes are data, not decorators |
+| **Panel** | the shell, visual themes, and the catalogue of sections with role grants |
+| **Users** | local accounts, roles, panel sessions, sign-in through an external provider |
+| **Database** | a SQLAlchemy layer with a pool, table declarations for two dialects |
+| **Replicas** | distributed locks, leader election, a message bus, a cluster registry |
+| **Observability** | audit of incoming requests, an event log, metrics, log shipping |
+
+## What it does not decide for you
+
+The framework carries no product. Anything it cannot know arrives through
+`KeepupSettings`: your name and version, where your logs are shipped, which
+fields of a request are secret, what a password must look like, which tables
+belong to you, which origins may read your answers.
+
+Where a default would have to guess, it closes rather than opens. Metrics are
+not served without credentials, no origin is allowed cross-origin, the audit
+keeps field names and not values, and there is no collector address, no signing
+key and no password anywhere in the source. An application says what it needs
+open; the package does not decide that on its behalf.
+
+## What is public
+
+A module that an application may import from declares `__all__`. Everything
+else is internal and may change without notice — including any name starting
+with an underscore, whatever module it sits in.
+
+`keepup/tests/public_interface_tests.py` holds this to the applications in the
+repository: a name taken out of the framework and not declared public fails the
+run, and the failure says what to do about it.
+
+## Requirements
+
+Python 3.11 or newer. PostgreSQL in production; SQLite works and is meant for
+development. `pip install keepup-admin[postgres]` adds the driver the bus
+between replicas needs.
+
+## Tests
+
+```bash
+ci/tests/keepup.sh          # the framework's own suite, needs no application
+```
+
+The suite runs against SQLite with no network and holds a coverage floor. The
+plugin runtime is the least covered part of the framework, and deliberately so
+for now: the test that exercises it hardest stands up a real application's
+plugins and therefore lives with that application. See `doc/keepup.md`.
+
+## Licence
+
+Apache 2.0. See `LICENSE`, and `NOTICE` for the attribution that clause 4(d)
+asks to travel with a derivative.
+
+The panel's front end also ships five third-party bundles -- Tailwind, Feather,
+AOS, Chart.js and its date adapter. All five are MIT and stay under their own
+terms; minification stripped their headers, so their notices live in
+`THIRD-PARTY.md`.

keepup_admin-0.1.0/README.md

@@ -0,0 +1,81 @@
+# keepup
+
+An admin framework over FastAPI. You give it settings; it gives you an
+application with a panel, a plugin runtime, users, a database layer, an audit,
+metrics and coordination between replicas already wired.
+
+```python
+from keepup import KeepupSettings, create_app
+
+app = create_app(KeepupSettings(title="Your product", project_name="yours"))
+```
+
+That is a running application with a working panel at `/selfcare`: the shell,
+the themes and eight administrative sections ship inside the package, so there
+is nothing to copy into your tree to see them.
+
+Installed as `keepup-admin`; imported as `keepup`. The name `keepup` on PyPI
+belongs to an unrelated project from 2015 that installs a script and no module,
+so the import name is free.
+
+## What it gives you
+
+| | |
+|---|---|
+| **Application assembly** | `create_app(settings)` — FastAPI, middleware, lifespan, static mounts |
+| **Plugin runtime** | features as plugins; routes are data, not decorators |
+| **Panel** | the shell, visual themes, and the catalogue of sections with role grants |
+| **Users** | local accounts, roles, panel sessions, sign-in through an external provider |
+| **Database** | a SQLAlchemy layer with a pool, table declarations for two dialects |
+| **Replicas** | distributed locks, leader election, a message bus, a cluster registry |
+| **Observability** | audit of incoming requests, an event log, metrics, log shipping |
+
+## What it does not decide for you
+
+The framework carries no product. Anything it cannot know arrives through
+`KeepupSettings`: your name and version, where your logs are shipped, which
+fields of a request are secret, what a password must look like, which tables
+belong to you, which origins may read your answers.
+
+Where a default would have to guess, it closes rather than opens. Metrics are
+not served without credentials, no origin is allowed cross-origin, the audit
+keeps field names and not values, and there is no collector address, no signing
+key and no password anywhere in the source. An application says what it needs
+open; the package does not decide that on its behalf.
+
+## What is public
+
+A module that an application may import from declares `__all__`. Everything
+else is internal and may change without notice — including any name starting
+with an underscore, whatever module it sits in.
+
+`keepup/tests/public_interface_tests.py` holds this to the applications in the
+repository: a name taken out of the framework and not declared public fails the
+run, and the failure says what to do about it.
+
+## Requirements
+
+Python 3.11 or newer. PostgreSQL in production; SQLite works and is meant for
+development. `pip install keepup-admin[postgres]` adds the driver the bus
+between replicas needs.
+
+## Tests
+
+```bash
+ci/tests/keepup.sh          # the framework's own suite, needs no application
+```
+
+The suite runs against SQLite with no network and holds a coverage floor. The
+plugin runtime is the least covered part of the framework, and deliberately so
+for now: the test that exercises it hardest stands up a real application's
+plugins and therefore lives with that application. See `doc/keepup.md`.
+
+## Licence
+
+Apache 2.0. See `LICENSE`, and `NOTICE` for the attribution that clause 4(d)
+asks to travel with a derivative.
+
+The panel's front end also ships five third-party bundles -- Tailwind, Feather,
+AOS, Chart.js and its date adapter. All five are MIT and stay under their own
+terms; minification stripped their headers, so their notices live in
+`THIRD-PARTY.md`.

keepup_admin-0.1.0/THIRD-PARTY.md

@@ -0,0 +1,44 @@
+# Third-party code shipped with this package
+
+The panel's front end is served from the package itself, and five of its files
+are third-party bundles rather than our code. They are vendored — kept in the
+tree and served from it — rather than fetched from a CDN, because the panel of
+an administrative tool should not depend on somebody else's server being up,
+and because a page that loads nothing from outside is one fewer place a
+deployment has to reason about.
+
+All five are minified, and minification stripped their licence headers. That
+is what this file is for: every one of them is MIT, and MIT asks that its
+notice travel with the copy.
+
+| File | Project | Licence |
+|---|---|---|
+| `static/js/tailwind.js` | Tailwind CSS (browser build) — https://tailwindcss.com | MIT, Copyright (c) Tailwind Labs, Inc. |
+| `static/js/feather-icons.js` | Feather — https://feathericons.com | MIT, Copyright (c) 2013-2023 Cole Bemis |
+| `static/js/aos.js` | AOS — https://michalsnik.github.io/aos/ | MIT, Copyright (c) 2015 Michał Sajnóg |
+| `static/modules/js/chart.js` | Chart.js — https://www.chartjs.org | MIT, Copyright (c) Chart.js Contributors |
+| `static/modules/js/chartjs-adapter-date-fns.bundle.min.js` | chartjs-adapter-date-fns — https://github.com/chartjs/chartjs-adapter-date-fns | MIT, Copyright (c) Chart.js Contributors |
+
+## The MIT licence
+
+> Permission is hereby granted, free of charge, to any person obtaining a copy
+> of this software and associated documentation files (the "Software"), to deal
+> in the Software without restriction, including without limitation the rights
+> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+> copies of the Software, and to permit persons to whom the Software is
+> furnished to do so, subject to the following conditions:
+>
+> The above copyright notice and this permission notice shall be included in all
+> copies or substantial portions of the Software.
+>
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALING IN THE
+> SOFTWARE.
+
+The licence of this package, whatever it is, does not reach these five files:
+they stay under the terms above, and replacing one of them means checking that
+its replacement's terms still allow this.

keepup_admin-0.1.0/__init__.py

@@ -0,0 +1,41 @@
+"""KeepUP — a framework over FastAPI for applications built like this one.
+
+An application supplies a :class:`~keepup.settings.KeepupSettings` and gets an
+application back from :func:`~keepup.factory.create_app`. Everything the
+framework cannot know -- the product's name, the collector its logs go to,
+which fields of a request are secret, what a password must look like, which
+tables belong to the product -- travels in those settings, never as a default
+in here. See ``doc/keepup.md``.
+
+Imported lazily: ``keepup.factory`` pulls in the database layer and the
+authentication provider, and importing the package to reach one constant
+should not do that.
+"""
+
+#: The framework's own version, which is the version of the distribution it
+#: was installed from -- not the version of the application it serves. The
+#: application's version is its own metadata and reaches the framework through
+#: settings; reading one for the other is how a panel ends up reporting the
+#: framework's number as the product's (keepup-5).
+try:
+    from importlib.metadata import version as _distribution_version
+
+    __version__ = _distribution_version("keepup-admin")
+except Exception:
+    # Running from a source tree that was never installed -- the repository
+    # itself, until the applications switch to installing by version.
+    __version__ = "0.0.0+source"
+
+__all__ = ["KeepupSettings", "StaticMount", "create_app", "__version__"]
+
+
+def __getattr__(name):
+    if name in ("KeepupSettings", "StaticMount"):
+        from keepup import settings
+
+        return getattr(settings, name)
+    if name == "create_app":
+        from keepup.factory import create_app
+
+        return create_app
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")

keepup_admin-0.1.0/api_versions.py

@@ -0,0 +1,100 @@
+"""API versions: the version in the path, and the paths without one.
+
+Clients cannot be updated together with the server: an agent is updated by the
+host owner copying an archive, the client inside a VM by rebuilding the image.
+So the model on the wire is pinned to a version named in the path -- `/api/v1/…`
+for HTTP, `/ws/v1/…` for websockets -- and a later incompatible model gets a new
+prefix while old clients keep talking to theirs.
+
+v1 is the model the routes have today, and their handlers do not know about it:
+this middleware maps `/api/v1/x` onto `/api/x` before routing, for the routes of
+the application and of every plugin at once, so no route dictionary changes. A
+path without a version stays an alias of v1 for as long as v1 exists (decision of
+17.09.2026): the panel is served with the server and has no reason to move, and
+agents already installed must not break. Its HTTP answers say so with a
+`Deprecation` header and a link to the versioned path.
+
+A future v2 route is registered under its own `/api/v2/…` path and is never
+rewritten. `/api/v2/websocket/token` and `/ws/v2/websocket` predate this scheme:
+they are the second version of the guest channel, whose first version is gone,
+and are listed as such in `/api/versions`.
+"""
+
+from typing import Any, Dict, List
+
+CURRENT = "v1"
+
+#: Every version the server speaks. `sunset` is when a deprecated version stops
+#: being served; None means no date is set.
+VERSIONS: List[Dict[str, Any]] = [
+    {"version": "v1", "status": "current", "http_prefix": "/api/v1", "websocket_prefix": "/ws/v1",
+     "sunset": None},
+]
+
+#: Paths that carry their own version outside the scheme above.
+CHANNEL_VERSIONS: List[Dict[str, str]] = [
+    {"channel": "guest", "version": "v2", "paths": "/api/v2/websocket/token, /ws/v2/websocket"},
+]
+
+#: Versioned prefix -> the unversioned prefix the routes are registered under.
+ALIASES = {"/api/v1": "/api", "/ws/v1": "/ws"}
+
+#: Unversioned paths that are not an alias of v1 and get no deprecation notice.
+NOT_DEPRECATED = ("/api/versions", "/api/v2/", "/api/v3/")
+
+
+def unversioned(path: str):
+    """The registered path for a versioned one, or None when the path has no v1 prefix."""
+    for versioned, plain in ALIASES.items():
+        if path == versioned or path.startswith(versioned + "/"):
+            return plain + path[len(versioned):]
+    return None
+
+
+def successor(path: str):
+    """The versioned path a deprecated unversioned one should become, or None."""
+    if path.startswith(NOT_DEPRECATED) or path == "/api":
+        return None
+    for versioned, plain in ALIASES.items():
+        if path.startswith(plain + "/") and not path.startswith(versioned + "/"):
+            return versioned + path[len(plain):]
+    return None
+
+
+def describe() -> Dict[str, Any]:
+    return {"current": CURRENT, "versions": VERSIONS, "channels": CHANNEL_VERSIONS,
+            "unversioned_paths": "alias of " + CURRENT}
+
+
+class ApiVersionMiddleware:
+    """Route `/api/v1/…` and `/ws/v1/…` to the handlers, mark unversioned answers."""
+
+    def __init__(self, app):
+        self.app = app
+
+    async def __call__(self, scope, receive, send):
+        if scope["type"] not in ("http", "websocket"):
+            return await self.app(scope, receive, send)
+
+        path = scope.get("path", "")
+        plain = unversioned(path)
+        if plain is not None:
+            scope = dict(scope)
+            scope["path"] = plain
+            scope["raw_path"] = plain.encode("utf-8")
+            scope["api_version"] = CURRENT
+            return await self.app(scope, receive, send)
+
+        target = successor(path) if scope["type"] == "http" else None
+        if target is None:
+            return await self.app(scope, receive, send)
+
+        async def send_with_notice(message):
+            if message["type"] == "http.response.start":
+                headers = list(message.get("headers", []))
+                headers.append((b"deprecation", b"true"))
+                headers.append((b"link", f'<{target}>; rel="successor-version"'.encode("utf-8")))
+                message = {**message, "headers": headers}
+            await send(message)
+
+        return await self.app(scope, receive, send_with_notice)