mflux-web 0.0.1a1__tar.gz

mflux_web-0.0.1a1/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.3
+Name: mflux-web
+Version: 0.0.1a1
+Summary: Web integration for mflux with a standalone Python API
+Author: Anthony Wu
+Author-email: Anthony Wu <462072+anthonywu@users.noreply.github.com>
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# mflux-web
+
+Install (once published):
+
+```sh
+pip install mflux-web
+```
+
+Both entry points resolve to the same module object:
+
+```python
+import mflux.web
+import mflux_web
+
+assert mflux.web is mflux_web
+```
+
+`mflux_web` owns the implementation and works without installing or importing
+`mflux`. Importing `mflux.web` registers it as an alias of `mflux_web`, sharing
+all public symbols and module state. Either import order works, and the greeting
+prints once per process. Submodules are not automatically aliased; use
+`mflux.web.<plugin>` for third-party plugins. This initial scaffold has no web
+server or application API yet.
+
+## Namespace ownership
+
+This distribution owns `mflux/web/__init__.py` and `mflux_web/`. It deliberately
+does **not** ship `mflux/__init__.py` or require the inference distribution.
+The `mflux.web` alias adds plugin directories discovered by `pkgutil.extend_path`
+to the shared package path, so other distributions can contribute subpackages
+even from separate import paths.
+
+A plugin distribution can ship:
+
+```text
+src/
+└── mflux/
+    └── web/
+        └── anythingelse/
+            └── __init__.py
+```
+
+With this uv build configuration:
+
+```toml
+[project]
+name = "mflux-web-anythingelse"
+version = "0.1.0"
+dependencies = ["mflux-web>=0.0.1a1"]
+
+[build-system]
+requires = ["uv_build>=0.12.15,<0.13.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "mflux.web.anythingelse"
+```
+
+Consumers can then use `import mflux.web.anythingelse`. Plugins must not ship
+`mflux/__init__.py` or `mflux/web/__init__.py`; each owns a unique child name.
+
+## Integration with the mflux parent
+
+The existing mflux project has a regular `mflux/__init__.py`. Normal wheel
+installations into the same site-packages directory coexist with this package.
+For separate editable installs or other split-path layouts, add this to the
+**mflux project's** existing `src/mflux/__init__.py`, retaining its current setup:
+
+```python
+from pkgutil import extend_path
+
+__path__ = extend_path(__path__, __name__)
+```
+
+Without that parent change, an installed regular mflux package can hide an
+editable mflux-web checkout. Setting `namespace = true` in build configuration
+does not change Python's runtime import behavior. This repository does not
+modify or replace the parent initializer.
+
+## Development
+
+Use uv-managed Python 3.14 for development; the library supports Python 3.11–3.15.
+
+```sh
+uv sync
+uv build
+uv run python -m unittest discover -s tests -v
+```
+
+The tests build the distributions in a temporary directory and check their
+contents and imports in isolated subprocesses, including third-party namespace
+contributions and regular-parent coexistence.

mflux_web-0.0.1a1/README.md

@@ -0,0 +1,92 @@
+# mflux-web
+
+Install (once published):
+
+```sh
+pip install mflux-web
+```
+
+Both entry points resolve to the same module object:
+
+```python
+import mflux.web
+import mflux_web
+
+assert mflux.web is mflux_web
+```
+
+`mflux_web` owns the implementation and works without installing or importing
+`mflux`. Importing `mflux.web` registers it as an alias of `mflux_web`, sharing
+all public symbols and module state. Either import order works, and the greeting
+prints once per process. Submodules are not automatically aliased; use
+`mflux.web.<plugin>` for third-party plugins. This initial scaffold has no web
+server or application API yet.
+
+## Namespace ownership
+
+This distribution owns `mflux/web/__init__.py` and `mflux_web/`. It deliberately
+does **not** ship `mflux/__init__.py` or require the inference distribution.
+The `mflux.web` alias adds plugin directories discovered by `pkgutil.extend_path`
+to the shared package path, so other distributions can contribute subpackages
+even from separate import paths.
+
+A plugin distribution can ship:
+
+```text
+src/
+└── mflux/
+    └── web/
+        └── anythingelse/
+            └── __init__.py
+```
+
+With this uv build configuration:
+
+```toml
+[project]
+name = "mflux-web-anythingelse"
+version = "0.1.0"
+dependencies = ["mflux-web>=0.0.1a1"]
+
+[build-system]
+requires = ["uv_build>=0.12.15,<0.13.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "mflux.web.anythingelse"
+```
+
+Consumers can then use `import mflux.web.anythingelse`. Plugins must not ship
+`mflux/__init__.py` or `mflux/web/__init__.py`; each owns a unique child name.
+
+## Integration with the mflux parent
+
+The existing mflux project has a regular `mflux/__init__.py`. Normal wheel
+installations into the same site-packages directory coexist with this package.
+For separate editable installs or other split-path layouts, add this to the
+**mflux project's** existing `src/mflux/__init__.py`, retaining its current setup:
+
+```python
+from pkgutil import extend_path
+
+__path__ = extend_path(__path__, __name__)
+```
+
+Without that parent change, an installed regular mflux package can hide an
+editable mflux-web checkout. Setting `namespace = true` in build configuration
+does not change Python's runtime import behavior. This repository does not
+modify or replace the parent initializer.
+
+## Development
+
+Use uv-managed Python 3.14 for development; the library supports Python 3.11–3.15.
+
+```sh
+uv sync
+uv build
+uv run python -m unittest discover -s tests -v
+```
+
+The tests build the distributions in a temporary directory and check their
+contents and imports in isolated subprocesses, including third-party namespace
+contributions and regular-parent coexistence.

mflux_web-0.0.1a1/pyproject.toml

@@ -0,0 +1,72 @@
+[project]
+name = "mflux-web"
+version = "0.0.1a1"
+description = "Web integration for mflux with a standalone Python API"
+readme = "README.md"
+requires-python = ">=3.11"
+classifiers = [
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
+]
+dependencies = []
+
+[[project.authors]]
+name = "Anthony Wu"
+email = "462072+anthonywu@users.noreply.github.com"
+
+[build-system]
+requires = ["uv_build>=0.12.15,<0.13.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = [
+    "mflux_web",
+    "mflux.web",
+]
+source-include = ["tests/**"]
+
+[tool.ruff]
+target-version = "py311"
+line-length = 88
+src = ["src"]
+
+[tool.ruff.lint]
+select = [
+    "E4",
+    "E7",
+    "E9",
+    "F",
+    "I",
+    "UP",
+    "B",
+    "SIM",
+    "RUF",
+]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+
+[tool.ty.environment]
+python-version = "3.11"
+
+[tool.ty.src]
+include = [
+    "src",
+    "tests",
+]
+
+[tool.ty.rules]
+unused-ignore-comment = "warn"
+
+[tool.ty.terminal]
+error-on-warning = true
+
+[dependency-groups]
+dev = [
+    "ruff>=0.16.9",
+    "ty>=0.0.84",
+]

mflux_web-0.0.1a1/pyproject.toml.orig

@@ -0,0 +1,56 @@
+[project]
+name = "mflux-web"
+version = "0.0.1a1"
+description = "Web integration for mflux with a standalone Python API"
+readme = "README.md"
+authors = [
+    { name = "Anthony Wu", email = "462072+anthonywu@users.noreply.github.com" }
+]
+requires-python = ">=3.11"
+classifiers = [
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
+]
+dependencies = []
+
+[build-system]
+requires = ["uv_build>=0.12.15,<0.13.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = ["mflux_web", "mflux.web"]
+source-include = ["tests/**"]
+
+[tool.ruff]
+target-version = "py311"
+line-length = 88
+src = ["src"]
+
+[tool.ruff.lint]
+# Core errors, import sorting, upgrades, bug risks, and simple cleanup.
+select = ["E4", "E7", "E9", "F", "I", "UP", "B", "SIM", "RUF"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+
+[tool.ty.environment]
+python-version = "3.11"
+
+[tool.ty.src]
+include = ["src", "tests"]
+
+[tool.ty.rules]
+unused-ignore-comment = "warn"
+
+[tool.ty.terminal]
+error-on-warning = true
+
+[dependency-groups]
+dev = [
+    "ruff>=0.16.9",
+    "ty>=0.0.84",
+]

mflux_web-0.0.1a1/src/mflux/web/__init__.py

@@ -0,0 +1,13 @@
+"""Alias mflux.web to the standalone mflux_web package."""
+
+import sys
+from pkgutil import extend_path
+
+import mflux_web
+
+# Keep plugin directories discoverable after replacing this module with the alias.
+for path in extend_path(__path__, __name__):
+    if path not in mflux_web.__path__:
+        mflux_web.__path__.append(path)
+
+sys.modules[__name__] = mflux_web

mflux_web-0.0.1a1/src/mflux_web/__init__.py

@@ -0,0 +1,9 @@
+"""Standalone web API; importing this package does not import mflux."""
+
+from importlib.metadata import version
+
+__version__ = version("mflux-web")
+
+__all__ = ["__version__"]
+
+print("Hello from mflux-web library")

mflux_web-0.0.1a1/tests/test_packaging.py

@@ -0,0 +1,131 @@
+"""Exercise built artifacts without relying on the editable source checkout."""
+
+import os
+import subprocess
+import sys
+import tempfile
+import unittest
+import zipfile
+from pathlib import Path
+
+ROOT = Path(__file__).resolve().parents[1]
+
+
+class PackagingTests(unittest.TestCase):
+    @classmethod
+    def setUpClass(cls):
+        cls.temp = tempfile.TemporaryDirectory()
+        cls.addClassCleanup(cls.temp.cleanup)
+        cls.root = Path(cls.temp.name)
+        dist = cls.root / "dist"
+        subprocess.run(
+            ["uv", "build", "--out-dir", str(dist)],
+            cwd=ROOT,
+            check=True,
+            capture_output=True,
+            text=True,
+        )
+        cls.site = cls.root / "site"
+        with zipfile.ZipFile(next(dist.glob("*.whl"))) as wheel:
+            cls.members = wheel.namelist()
+            wheel.extractall(cls.site)
+
+    def run_imports(self, code, *paths):
+        # -I -S prevents the project's editable install and user site from leaking in.
+        setup = f"import sys; sys.path[:0] = {[str(p) for p in paths]!r}\n"
+        result = subprocess.run(
+            [sys.executable, "-I", "-S", "-c", setup + code],
+            check=False,
+            cwd=self.root,
+            capture_output=True,
+            text=True,
+            env={k: v for k, v in os.environ.items() if k != "PYTHONPATH"},
+        )
+        self.assertEqual(result.returncode, 0, result.stderr)
+        return result.stdout
+
+    def test_wheel_ownership(self):
+        self.assertIn("mflux/web/__init__.py", self.members)
+        self.assertIn("mflux_web/__init__.py", self.members)
+        self.assertNotIn("mflux/__init__.py", self.members)
+        self.assertFalse(any("mflux_web_pypi" in name for name in self.members))
+
+    def test_standalone_does_not_import_parent(self):
+        self.run_imports(
+            'import mflux_web\nassert "mflux" not in sys.modules\n'
+            'assert mflux_web.__version__ == "0.0.1a1"',
+            self.site,
+        )
+
+    def test_both_entry_points(self):
+        for imports in (
+            "import mflux.web\nimport mflux_web",
+            "import mflux_web\nimport mflux.web",
+            "from mflux import web\nimport mflux.web\nimport mflux_web",
+        ):
+            with self.subTest(imports=imports):
+                output = self.run_imports(
+                    imports + "\n"
+                    "assert mflux.web is mflux_web\n"
+                    'assert sys.modules["mflux.web"] is mflux_web\n'
+                    "mflux.web.shared_value = 42\n"
+                    "assert mflux_web.shared_value == 42",
+                    self.site,
+                )
+                self.assertEqual(output, "Hello from mflux-web library\n")
+
+    def test_plugin_on_separate_path(self):
+        plugin_root = self.root / "plugin"
+        plugin = plugin_root / "mflux/web/anythingelse"
+        plugin.mkdir(parents=True)
+        (plugin / "__init__.py").write_text("VALUE = 42\n")
+        self.run_imports(
+            "import mflux.web.anythingelse, mflux_web\n"
+            "assert mflux.web is mflux_web\n"
+            "assert mflux.web.anythingelse.VALUE == 42\n"
+            "assert mflux_web.anythingelse is mflux.web.anythingelse",
+            self.site,
+            plugin_root,
+        )
+
+    def test_regular_parent_in_same_site(self):
+        import shutil
+
+        site = self.root / "coinstalled"
+        shutil.copytree(self.site, site)
+        (site / "mflux/__init__.py").write_text("PARENT = True\n")
+        self.run_imports(
+            "import mflux.web\nassert mflux.PARENT",
+            site,
+        )
+
+    def test_split_parent_with_extend_path(self):
+        parent_root = self.root / "parent"
+        parent = parent_root / "mflux"
+        parent.mkdir(parents=True)
+        (parent / "__init__.py").write_text(
+            "from pkgutil import extend_path\n"
+            "__path__ = extend_path(__path__, __name__)\n"
+            "PARENT = True\n"
+        )
+        self.run_imports(
+            "import mflux.web\nassert mflux.PARENT",
+            parent_root,
+            self.site,
+        )
+
+    def test_unmodified_split_parent_hides_web(self):
+        parent_root = self.root / "unmodified"
+        parent = parent_root / "mflux"
+        parent.mkdir(parents=True)
+        (parent / "__init__.py").write_text("PARENT = True\n")
+        self.run_imports(
+            "import importlib.util, mflux_web\n"
+            'assert importlib.util.find_spec("mflux.web") is None',
+            parent_root,
+            self.site,
+        )
+
+
+if __name__ == "__main__":
+    unittest.main()