yhub 0.0.1__tar.gz

yhub-0.0.1/.github/workflows/publish.yml

@@ -0,0 +1,29 @@
+name: publish
+
+# Publishes the built distributions to PyPI.
+#
+# First publish of a brand-new project name uses a PyPI *pending publisher* (no secrets needed):
+#   PyPI → Account → Publishing → "Add a pending publisher"
+#     PyPI project name: yhub
+#     Owner:             ifeitao
+#     Repository name:   yhub
+#     Workflow name:     publish.yml
+#     Environment name:  pypi
+# After that, publishing a GitHub Release (or running this workflow manually) uploads with OIDC.
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  pypi:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write # required for trusted publishing (OIDC)
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - run: uv build --no-sources
+      - run: uv publish

yhub-0.0.1/.gitignore

@@ -0,0 +1,6 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+.venv/

yhub-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Yifeitao
+
+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 DEALINGS IN THE
+SOFTWARE.

yhub-0.0.1/PKG-INFO

@@ -0,0 +1,58 @@
+Metadata-Version: 2.5
+Name: yhub
+Version: 0.0.1
+Summary: Name reservation for yhub — an always-on local hub for your own machines and services.
+Project-URL: Homepage, https://github.com/ifeitao/yhub
+Project-URL: Repository, https://github.com/ifeitao/yhub
+Project-URL: Issues, https://github.com/ifeitao/yhub/issues
+Author: Yifeitao
+License-Expression: MIT
+License-File: LICENSE
+Keywords: cli,dashboard,homelab,mcp,monitoring,self-hosted
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Environment :: Console
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: System :: Monitoring
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# yhub
+
+**This is a name-reservation release (`0.0.1`).** It reserves the distribution name `yhub` on
+PyPI and does nothing else.
+
+The real package — **an always-on local hub for your own machines, services and pipelines**
+(CLI + web dashboard + MCP server, installed from a single wheel) — is planned for **2027**.
+
+Nothing in this repository is a working product yet. Please don't build on it.
+
+## What the real release will be
+
+- **Information surface**: a wall of status cells (services, sync pipelines, scheduled jobs,
+  mounts) you keep on screen, each cell a three-state reading — fresh / stale / failing.
+- **Action surface**: buttons, toggles and inputs on those same cells, so a cell can *do*
+  something, not just report.
+- **Three faces from one declaration**: every capability is declared once and generated into a
+  CLI command, an HTTP route and an MCP tool.
+- **Local by default**: binds `127.0.0.1` only; reads the machine it runs on (local daemons,
+  mounts, files), not a cloud account.
+
+## Verify the install
+
+```bash
+uv tool install yhub
+yhub --version          # -> yhub 0.0.1
+```
+
+or without installing anything:
+
+```bash
+uv run --no-project --with yhub python -m yhub --version
+```
+
+## License
+
+MIT — see [LICENSE](LICENSE).

yhub-0.0.1/PUBLISHING.md

@@ -0,0 +1,80 @@
+# Publishing `yhub` 0.0.1 (name reservation)
+
+Everything here is prepared; the only steps left need your PyPI/GitHub credentials.
+
+## 0. Check what will be uploaded
+
+```bash
+cd ~/Projects/yhub
+uv build --no-sources        # -> dist/yhub-0.0.1-py3-none-any.whl + dist/yhub-0.0.1.tar.gz
+uv run --no-project --with ./dist/yhub-0.0.1-py3-none-any.whl yhub --version
+```
+
+## Option A — fastest one-off (API token)
+
+The project does not exist yet, so you need an **account-scoped** token
+(PyPI → Account settings → API tokens → "Add API token", scope = *entire account*).
+
+```bash
+cd ~/Projects/yhub
+uv build --no-sources
+UV_PUBLISH_TOKEN=pypi-... uv publish
+```
+
+After the project exists you can (and should) switch to a project-scoped token, or to Option B.
+
+## Option B — recommended, no secrets (trusted publishing)
+
+1. Create the GitHub repo `ifeitao/yhub` and push these files.
+2. On PyPI: **Account → Publishing → Add a pending publisher**
+   - PyPI project name: `yhub`
+   - Owner: `ifeitao`
+   - Repository name: `yhub`
+   - Workflow name: `publish.yml`
+   - Environment name: `pypi`
+3. Create a GitHub Release (or run the `publish` workflow manually). `.github/workflows/publish.yml`
+   builds and uploads with OIDC — no token anywhere.
+
+## Rehearse on TestPyPI first (recommended)
+
+Add this to `pyproject.toml`:
+
+```toml
+[[tool.uv.index]]
+name = "testpypi"
+url = "https://test.pypi.org/simple/"
+publish-url = "https://test.pypi.org/legacy/"
+explicit = true
+```
+
+Then:
+
+```bash
+uv build --no-sources
+uv publish --index testpypi            # needs a TestPyPI token (separate account)
+uv run --no-project --index-url https://test.pypi.org/simple/ --with yhub yhub --version
+```
+
+## After publishing
+
+```bash
+uv tool install yhub --refresh
+yhub --version         # -> yhub 0.0.1
+```
+
+## Notes and pitfalls
+
+- **The license is baked into 0.0.1 permanently.** `license = "MIT"` is what this version will
+  carry forever; changing it later only affects new releases. Confirm MIT (simplest, most
+  permissive) vs Apache-2.0 (adds an explicit patent grant, common for dev tools) *before*
+  uploading.
+- **PEP 639 needs hatchling >= 1.27** for `license = "MIT"` + `license-files`; the pin in
+  `pyproject.toml` says so.
+- **`uv build --no-sources`** is the documented build for publishing (builds resolve without
+  `tool.uv.sources`).
+- PyPI rejects new names that are **too similar to an existing project** (`-`, `_`, `.` count as
+  the same character). Reserving `yhub` therefore also blocks look-alikes such as `y-hub`.
+- Do **not** publish empty metadata-only releases: a name claimed with no intent to use can be
+  reclaimed by PyPI. This package has a real, runnable entry point and a README explaining the
+  reservation, which is the intended shape.
+- PyPI no longer accepts username/password uploads — token or trusted publishing only.

yhub-0.0.1/README.md

@@ -0,0 +1,37 @@
+# yhub
+
+**This is a name-reservation release (`0.0.1`).** It reserves the distribution name `yhub` on
+PyPI and does nothing else.
+
+The real package — **an always-on local hub for your own machines, services and pipelines**
+(CLI + web dashboard + MCP server, installed from a single wheel) — is planned for **2027**.
+
+Nothing in this repository is a working product yet. Please don't build on it.
+
+## What the real release will be
+
+- **Information surface**: a wall of status cells (services, sync pipelines, scheduled jobs,
+  mounts) you keep on screen, each cell a three-state reading — fresh / stale / failing.
+- **Action surface**: buttons, toggles and inputs on those same cells, so a cell can *do*
+  something, not just report.
+- **Three faces from one declaration**: every capability is declared once and generated into a
+  CLI command, an HTTP route and an MCP tool.
+- **Local by default**: binds `127.0.0.1` only; reads the machine it runs on (local daemons,
+  mounts, files), not a cloud account.
+
+## Verify the install
+
+```bash
+uv tool install yhub
+yhub --version          # -> yhub 0.0.1
+```
+
+or without installing anything:
+
+```bash
+uv run --no-project --with yhub python -m yhub --version
+```
+
+## License
+
+MIT — see [LICENSE](LICENSE).

yhub-0.0.1/pyproject.toml

@@ -0,0 +1,35 @@
+[project]
+name = "yhub"
+version = "0.0.1"
+description = "Name reservation for yhub — an always-on local hub for your own machines and services."
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "Yifeitao" }]
+keywords = ["dashboard", "self-hosted", "homelab", "monitoring", "cli", "mcp"]
+classifiers = [
+  "Development Status :: 2 - Pre-Alpha",
+  "Environment :: Console",
+  "Operating System :: MacOS",
+  "Operating System :: POSIX :: Linux",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Topic :: System :: Monitoring",
+]
+
+[project.urls]
+Homepage = "https://github.com/ifeitao/yhub"
+Repository = "https://github.com/ifeitao/yhub"
+Issues = "https://github.com/ifeitao/yhub/issues"
+
+[project.scripts]
+yhub = "yhub.__main__:main"
+
+[build-system]
+# PEP 639 (SPDX license string + license-files) needs hatchling >= 1.27.
+requires = ["hatchling>=1.27"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["yhub"]

yhub-0.0.1/yhub/__init__.py

@@ -0,0 +1,9 @@
+"""yhub — name-reservation release.
+
+The real package (a CLI + web dashboard + MCP server for your own machines, services and
+pipelines) is planned for 2027. This release only reserves the distribution name on PyPI.
+"""
+
+__version__ = "0.0.1"
+
+__all__ = ["__version__"]

yhub-0.0.1/yhub/__main__.py

@@ -0,0 +1,40 @@
+"""Console entry point for the yhub name-reservation release."""
+
+from __future__ import annotations
+
+import sys
+
+from . import __version__
+
+_NAME = "yhub"
+_TAGLINE = "an always-on local hub for your own machines, services and pipelines"
+
+
+def _text() -> str:
+    return (
+        f"{_NAME} {__version__} — name-reservation release\n"
+        "\n"
+        "This release reserves the distribution name on PyPI and does nothing else.\n"
+        f"The real package ({_TAGLINE}) is planned for 2027: CLI + web dashboard + MCP\n"
+        "server, installed from a single wheel.\n"
+        "\n"
+        f"Until then, `{_NAME} --version` is all this package does.\n"
+    )
+
+
+def main(argv: list[str] | None = None) -> int:
+    """Print the reservation notice. `--version` / `--help` are the only recognised flags."""
+    args = list(sys.argv[1:] if argv is None else argv)
+    if args and args[0] in ("-V", "--version"):
+        print(f"{_NAME} {__version__}")
+        return 0
+    if args and args[0] in ("-h", "--help"):
+        print(_text())
+        print(f"usage: {_NAME} [--version | --help]")
+        return 0
+    print(_text())
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())