scripticus-server 0.1.0__tar.gz

scripticus_server-0.1.0/PKG-INFO

@@ -0,0 +1,62 @@
+Metadata-Version: 2.4
+Name: scripticus-server
+Version: 0.1.0
+Summary: A package manager and registry for scripts — index service
+License-Expression: MIT
+Requires-Dist: fastapi>=0.115
+Requires-Dist: uvicorn>=0.30
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# Scripticus server
+
+The index service for [Scripticus](https://github.com/kevinchannon/scripticus),
+a package manager and registry for scripts. The server provides
+manifest-aware search, version and dependency resolution, and the publish
+path for a Scripticus registry. Installing this package provides the
+`scripticus-svr` command.
+
+## Running the server
+
+`scripticus-svr` starts the service, printing its version and address on
+start-up:
+
+```console
+$ scripticus-svr --host 0.0.0.0 --port 8000
+scripticus-svr 0.1.0 — serving on http://0.0.0.0:8000 (interactive API docs at http://0.0.0.0:8000/docs)
+```
+
+Both options are optional; the default is `127.0.0.1:8000`. The API is
+self-describing: interactive docs are served at `/docs` and the OpenAPI
+spec at `/openapi.json`.
+
+### Health check
+
+`GET /health` returns `200` with `{"status": "ok"}` while the service is
+up. It is deliberately unauthenticated — it's a liveness probe for load
+balancers and container orchestrators.
+
+### Docker
+
+The repository ships a `docker-compose.yml` running the index service as a
+single container:
+
+```console
+$ docker compose up -d
+$ curl http://localhost:8000/health
+{"status":"ok"}
+```
+
+The intended v1 deployment pairs the index service with a Gitea instance
+that provides storage, authentication, and namespace ownership; Gitea
+integration doesn't exist yet, so the compose file is currently
+server-only and does not stand up a working registry.
+
+Once Gitea is part of the bundle: accounts and organisations are managed
+in Gitea; a Scripticus namespace is a Gitea user or organisation, claimed
+first-come-first-served, and publish rights follow Gitea's own membership
+and ACLs. The `library` namespace is reserved.
+
+## Licence
+
+MIT

scripticus_server-0.1.0/README.md

@@ -0,0 +1,52 @@
+# Scripticus server
+
+The index service for [Scripticus](https://github.com/kevinchannon/scripticus),
+a package manager and registry for scripts. The server provides
+manifest-aware search, version and dependency resolution, and the publish
+path for a Scripticus registry. Installing this package provides the
+`scripticus-svr` command.
+
+## Running the server
+
+`scripticus-svr` starts the service, printing its version and address on
+start-up:
+
+```console
+$ scripticus-svr --host 0.0.0.0 --port 8000
+scripticus-svr 0.1.0 — serving on http://0.0.0.0:8000 (interactive API docs at http://0.0.0.0:8000/docs)
+```
+
+Both options are optional; the default is `127.0.0.1:8000`. The API is
+self-describing: interactive docs are served at `/docs` and the OpenAPI
+spec at `/openapi.json`.
+
+### Health check
+
+`GET /health` returns `200` with `{"status": "ok"}` while the service is
+up. It is deliberately unauthenticated — it's a liveness probe for load
+balancers and container orchestrators.
+
+### Docker
+
+The repository ships a `docker-compose.yml` running the index service as a
+single container:
+
+```console
+$ docker compose up -d
+$ curl http://localhost:8000/health
+{"status":"ok"}
+```
+
+The intended v1 deployment pairs the index service with a Gitea instance
+that provides storage, authentication, and namespace ownership; Gitea
+integration doesn't exist yet, so the compose file is currently
+server-only and does not stand up a working registry.
+
+Once Gitea is part of the bundle: accounts and organisations are managed
+in Gitea; a Scripticus namespace is a Gitea user or organisation, claimed
+first-come-first-served, and publish rights follow Gitea's own membership
+and ACLs. The `library` namespace is reserved.
+
+## Licence
+
+MIT

scripticus_server-0.1.0/pyproject.toml

@@ -0,0 +1,24 @@
+[project]
+name = "scripticus-server"
+version = "0.1.0"
+description = "A package manager and registry for scripts — index service"
+readme = "README.md"
+requires-python = ">=3.11"
+license = "MIT"
+dependencies = [
+    "fastapi>=0.115",
+    "uvicorn>=0.30",
+]
+
+[project.scripts]
+scripticus-svr = "scripticus_server.main:main"
+
+[dependency-groups]
+dev = [
+    "pytest>=8",
+    "httpx2>=0.1",
+]
+
+[build-system]
+requires = ["uv_build>=0.11,<0.12"]
+build-backend = "uv_build"

scripticus_server-0.1.0/src/scripticus_server/__init__.py

@@ -0,0 +1,3 @@
+from importlib.metadata import version
+
+__version__ = version("scripticus-server")

scripticus_server-0.1.0/src/scripticus_server/app.py

@@ -0,0 +1,29 @@
+from typing import Literal
+
+from fastapi import FastAPI
+from pydantic import BaseModel
+
+from scripticus_server import __version__
+
+app = FastAPI(
+    title="Scripticus index service",
+    description=(
+        "Manifest-aware search, version and dependency resolution, and the "
+        "publish path for a Scripticus registry."
+    ),
+    version=__version__,
+)
+
+
+# Local to the server on purpose: a liveness shape is not part of the
+# package contract, so it doesn't meet the schema/ admission rule (D29).
+class HealthStatus(BaseModel):
+    status: Literal["ok"] = "ok"
+
+
+# Unauthenticated by design: a liveness probe carries nothing worth gating,
+# and the index service stays out of the ACL business anyway (D24). Leave it
+# open even once other endpoints grow auth.
+@app.get("/health")
+def health() -> HealthStatus:
+    return HealthStatus()

scripticus_server-0.1.0/src/scripticus_server/main.py

@@ -0,0 +1,45 @@
+import argparse
+
+import uvicorn
+
+from scripticus_server import __version__
+from scripticus_server.app import app
+
+
+def _parse_args(argv: list[str] | None = None) -> argparse.Namespace:
+    parser = argparse.ArgumentParser(
+        prog="scripticus-svr",
+        description=(
+            "Scripticus index service — search, resolution, and publishing "
+            "for shared scripts."
+        ),
+    )
+    parser.add_argument(
+        "--host",
+        default="127.0.0.1",
+        help="Interface to bind to (default: %(default)s).",
+    )
+    parser.add_argument(
+        "--port",
+        type=int,
+        default=8000,
+        help="Port to serve on (default: %(default)s).",
+    )
+    return parser.parse_args(argv)
+
+
+def _banner(host: str, port: int) -> str:
+    return (
+        f"scripticus-svr {__version__} — serving on http://{host}:{port} "
+        f"(interactive API docs at http://{host}:{port}/docs)"
+    )
+
+
+def main(argv: list[str] | None = None) -> None:
+    args = _parse_args(argv)
+    print(_banner(args.host, args.port), flush=True)
+    uvicorn.run(app, host=args.host, port=args.port)
+
+
+if __name__ == "__main__":
+    main()