fitsolver-client 0.1.0__tar.gz

fitsolver_client-0.1.0/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.4
+Name: fitsolver-client
+Version: 0.1.0
+Summary: Minimal ctypes client for the FitSolver C ABI (fitsolver_lib)
+Author: Fantastic Division
+Project-URL: Homepage, https://github.com/FantasticDivision/Solver
+Project-URL: Source, https://github.com/FantasticDivision/Solver
+Keywords: bin-packing,packing,fitsolver,logistics
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# fitsolver-client
+
+A minimal, dependency-free `ctypes` client for the FitSolver C ABI
+(`fitsolver_lib`). JSON in, JSON out -- the same contract as
+`fitsolver.solve()`, but without needing a compiled CPython extension.
+
+## Install
+
+### As a normal dependency (portal team, deployments)
+
+Released wheels **vendor the native `fitsolver_lib`** inside the package,
+so there is nothing else to build or configure:
+
+```bash
+pip install fitsolver-client
+```
+
+```
+# requirements.txt / pyproject.toml
+fitsolver-client==0.1.0
+```
+
+One wheel is published per OS (Linux `manylinux_2_28`, macOS x86_64 +
+arm64, Windows x64); each is valid for every Python >= 3.9. See
+`.github/workflows/wheels.yml` for how they are built and published.
+
+### From a local checkout (multi-repo development)
+
+```bash
+pip install -e path/to/FantasticSolver/python/fitsolver_client \
+  --config-settings editable_mode=compat
+```
+
+`editable_mode=compat` writes a plain-path `.pth` instead of an import
+hook, so editors / Pylance resolve `import fitsolver_client` statically.
+An editable install has no vendored library; it uses your local `build/`
+(see below), so a `cmake --build` is picked up with no reinstall.
+
+## The shared library
+
+Resolution order at the first `solve()` call:
+
+1. `FITSOLVER_LIB_PATH` -- exact path to the `.dll` / `.so` / `.dylib`.
+2. `FITSOLVER_REPO_ROOT` -- looked up under `<root>/build/`.
+3. A `build/` directory found by walking up from this package's location
+   (covers `pip install -e` from inside a FitSolver checkout).
+4. `fitsolver_client/_libs/` -- the copy vendored into a release wheel.
+
+Importing the package never fails on its own; only `solve()` does, with
+`SolverUnavailableError`, if none of the above resolve.
+
+To build the library for a local checkout:
+
+```bash
+cmake -B build
+cmake --build build --config Release --target fitsolver_lib
+```
+
+## Building a wheel by hand
+
+```bash
+cmake --build build --config Release --target fitsolver_lib
+python python/fitsolver_client/tools/vendor_lib.py --build-dir build
+python -m build --wheel python/fitsolver_client
+# optional: normalise the tag to py3-none-<platform>
+python -m wheel tags --python-tag py3 --abi-tag none \
+  --platform-tag win_amd64 --remove python/fitsolver_client/dist/*.whl
+```
+
+## Usage
+
+```python
+import fitsolver_client
+
+response = fitsolver_client.solve({
+    "items": [
+        {"ItemCode": "ITM-001", "ItemReference": "Widget A",
+         "Width": 100, "Length": 200, "Depth": 50, "Weight": 1.0},
+    ],
+    "boxes": [
+        {"Reference": "SML", "Width": 150, "Length": 150, "Depth": 150,
+         "MaxWeight": 8.5},
+    ],
+})
+```
+
+See the FitSolver README's "Request / response JSON schema" section for the
+exact shape of the request and response dicts.

fitsolver_client-0.1.0/README.md

@@ -0,0 +1,88 @@
+# fitsolver-client
+
+A minimal, dependency-free `ctypes` client for the FitSolver C ABI
+(`fitsolver_lib`). JSON in, JSON out -- the same contract as
+`fitsolver.solve()`, but without needing a compiled CPython extension.
+
+## Install
+
+### As a normal dependency (portal team, deployments)
+
+Released wheels **vendor the native `fitsolver_lib`** inside the package,
+so there is nothing else to build or configure:
+
+```bash
+pip install fitsolver-client
+```
+
+```
+# requirements.txt / pyproject.toml
+fitsolver-client==0.1.0
+```
+
+One wheel is published per OS (Linux `manylinux_2_28`, macOS x86_64 +
+arm64, Windows x64); each is valid for every Python >= 3.9. See
+`.github/workflows/wheels.yml` for how they are built and published.
+
+### From a local checkout (multi-repo development)
+
+```bash
+pip install -e path/to/FantasticSolver/python/fitsolver_client \
+  --config-settings editable_mode=compat
+```
+
+`editable_mode=compat` writes a plain-path `.pth` instead of an import
+hook, so editors / Pylance resolve `import fitsolver_client` statically.
+An editable install has no vendored library; it uses your local `build/`
+(see below), so a `cmake --build` is picked up with no reinstall.
+
+## The shared library
+
+Resolution order at the first `solve()` call:
+
+1. `FITSOLVER_LIB_PATH` -- exact path to the `.dll` / `.so` / `.dylib`.
+2. `FITSOLVER_REPO_ROOT` -- looked up under `<root>/build/`.
+3. A `build/` directory found by walking up from this package's location
+   (covers `pip install -e` from inside a FitSolver checkout).
+4. `fitsolver_client/_libs/` -- the copy vendored into a release wheel.
+
+Importing the package never fails on its own; only `solve()` does, with
+`SolverUnavailableError`, if none of the above resolve.
+
+To build the library for a local checkout:
+
+```bash
+cmake -B build
+cmake --build build --config Release --target fitsolver_lib
+```
+
+## Building a wheel by hand
+
+```bash
+cmake --build build --config Release --target fitsolver_lib
+python python/fitsolver_client/tools/vendor_lib.py --build-dir build
+python -m build --wheel python/fitsolver_client
+# optional: normalise the tag to py3-none-<platform>
+python -m wheel tags --python-tag py3 --abi-tag none \
+  --platform-tag win_amd64 --remove python/fitsolver_client/dist/*.whl
+```
+
+## Usage
+
+```python
+import fitsolver_client
+
+response = fitsolver_client.solve({
+    "items": [
+        {"ItemCode": "ITM-001", "ItemReference": "Widget A",
+         "Width": 100, "Length": 200, "Depth": 50, "Weight": 1.0},
+    ],
+    "boxes": [
+        {"Reference": "SML", "Width": 150, "Length": 150, "Depth": 150,
+         "MaxWeight": 8.5},
+    ],
+})
+```
+
+See the FitSolver README's "Request / response JSON schema" section for the
+exact shape of the request and response dicts.

fitsolver_client-0.1.0/fitsolver_client/__init__.py

@@ -0,0 +1,128 @@
+"""Minimal ctypes client for the FitSolver C ABI (fitsolver_lib).
+
+Deliberately thin: pure Python, no build step for the caller. A wheel
+built for distribution vendors the native fitsolver_lib shared library
+inside the package (fitsolver_client/_libs/), so `pip install
+fitsolver-client` is self-contained -- no CMake, no env vars.
+
+Library location is resolved in this order:
+  1. FITSOLVER_LIB_PATH env var, if set -- the exact file to load.
+  2. FITSOLVER_REPO_ROOT env var, if set -- look under <root>/build/.
+  3. A build/ directory found by walking up from this file's own
+     location -- covers `pip install -e` from inside a FitSolver
+     checkout (multi-repo dev: the live build/ wins over any vendored
+     copy so a rebuild is picked up immediately).
+  4. The _libs/ directory vendored into this package by the wheel build
+     -- the normal path for an installed (non-editable) release.
+
+See example/python_example.py in the FitSolver repo for the original,
+single-file version of this same pattern.
+"""
+
+import ctypes
+import json
+import os
+import platform
+from pathlib import Path
+
+__all__ = ["solve", "SolverUnavailableError"]
+
+
+class SolverUnavailableError(RuntimeError):
+    """Raised when the fitsolver_lib shared library can't be found or loaded."""
+
+
+def _library_filename() -> str:
+    return {
+        "Windows": "fitsolver_lib.dll",
+        "Darwin": "fitsolver_lib.dylib",
+    }.get(platform.system(), "fitsolver_lib.so")
+
+
+def _candidate_build_dirs() -> list[Path]:
+    candidates = []
+
+    repo_root = os.environ.get("FITSOLVER_REPO_ROOT")
+    if repo_root:
+        candidates.append(Path(repo_root) / "build")
+
+    # Walk up from this file looking for a sibling build/ directory.
+    here = Path(__file__).resolve()
+    candidates.extend(parent / "build" for parent in here.parents)
+
+    return candidates
+
+
+def _bundled_library(filename: str) -> Path | None:
+    """The copy a distribution wheel vendors next to this module. Absent
+    in an editable/source checkout -- populated only by the wheel build
+    (see tools/vendor_lib.py + pyproject.toml package-data)."""
+    candidate = Path(__file__).resolve().parent / "_libs" / filename
+    return candidate if candidate.is_file() else None
+
+
+def _find_library() -> Path:
+    explicit = os.environ.get("FITSOLVER_LIB_PATH")
+    if explicit:
+        path = Path(explicit)
+        if path.is_file():
+            return path
+        raise SolverUnavailableError(f"FITSOLVER_LIB_PATH is set but not a file: {explicit}")
+
+    filename = _library_filename()
+
+    # A live build/ from a dev checkout wins over the vendored copy, so a
+    # local `cmake --build` is picked up without reinstalling.
+    for build_dir in _candidate_build_dirs():
+        for sub in ("Release", "Debug", "."):
+            candidate = build_dir / sub / filename
+            if candidate.is_file():
+                return candidate
+
+    bundled = _bundled_library(filename)
+    if bundled is not None:
+        return bundled
+
+    raise SolverUnavailableError(
+        f"Could not find {filename}. Install a release wheel of "
+        "fitsolver-client (which vendors it), or build it in the FitSolver "
+        "repo (cmake -B build && cmake --build build --config Release "
+        "--target fitsolver_lib), or set FITSOLVER_LIB_PATH to its exact "
+        "location."
+    )
+
+
+_lib: ctypes.CDLL | None = None
+
+
+def _get_lib() -> ctypes.CDLL:
+    # Loaded lazily (on first solve() call, not at import time) so
+    # importing this package never fails just because the DLL hasn't
+    # been built yet -- only actually calling solve() does.
+    global _lib
+    if _lib is None:
+        lib = ctypes.CDLL(str(_find_library()))
+        lib.fitsolver_solve.argtypes = [ctypes.c_char_p]
+        lib.fitsolver_solve.restype = ctypes.c_void_p
+        lib.fitsolver_free.argtypes = [ctypes.c_void_p]
+        _lib = lib
+    return _lib
+
+
+def solve(request: dict) -> dict:
+    """Sends a {"items": [...], "boxes": [...]} request through the
+    fitsolver_lib C ABI and returns the parsed JSON response as a dict.
+
+    See the FitSolver README's "Request / response JSON schema" section
+    for the exact shape of `request` and the returned dict.
+    """
+    lib = _get_lib()
+    request_bytes = json.dumps(request).encode("utf-8")
+    response_ptr = lib.fitsolver_solve(request_bytes)
+    try:
+        # c_void_p (not c_char_p) on the ctypes signature so we keep the
+        # real pointer and can correctly free it afterwards.
+        response_bytes = ctypes.cast(response_ptr, ctypes.c_char_p).value
+        return json.loads(response_bytes.decode("utf-8"))
+    finally:
+        lib.fitsolver_free(response_ptr)

fitsolver_client-0.1.0/fitsolver_client.egg-info/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.4
+Name: fitsolver-client
+Version: 0.1.0
+Summary: Minimal ctypes client for the FitSolver C ABI (fitsolver_lib)
+Author: Fantastic Division
+Project-URL: Homepage, https://github.com/FantasticDivision/Solver
+Project-URL: Source, https://github.com/FantasticDivision/Solver
+Keywords: bin-packing,packing,fitsolver,logistics
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# fitsolver-client
+
+A minimal, dependency-free `ctypes` client for the FitSolver C ABI
+(`fitsolver_lib`). JSON in, JSON out -- the same contract as
+`fitsolver.solve()`, but without needing a compiled CPython extension.
+
+## Install
+
+### As a normal dependency (portal team, deployments)
+
+Released wheels **vendor the native `fitsolver_lib`** inside the package,
+so there is nothing else to build or configure:
+
+```bash
+pip install fitsolver-client
+```
+
+```
+# requirements.txt / pyproject.toml
+fitsolver-client==0.1.0
+```
+
+One wheel is published per OS (Linux `manylinux_2_28`, macOS x86_64 +
+arm64, Windows x64); each is valid for every Python >= 3.9. See
+`.github/workflows/wheels.yml` for how they are built and published.
+
+### From a local checkout (multi-repo development)
+
+```bash
+pip install -e path/to/FantasticSolver/python/fitsolver_client \
+  --config-settings editable_mode=compat
+```
+
+`editable_mode=compat` writes a plain-path `.pth` instead of an import
+hook, so editors / Pylance resolve `import fitsolver_client` statically.
+An editable install has no vendored library; it uses your local `build/`
+(see below), so a `cmake --build` is picked up with no reinstall.
+
+## The shared library
+
+Resolution order at the first `solve()` call:
+
+1. `FITSOLVER_LIB_PATH` -- exact path to the `.dll` / `.so` / `.dylib`.
+2. `FITSOLVER_REPO_ROOT` -- looked up under `<root>/build/`.
+3. A `build/` directory found by walking up from this package's location
+   (covers `pip install -e` from inside a FitSolver checkout).
+4. `fitsolver_client/_libs/` -- the copy vendored into a release wheel.
+
+Importing the package never fails on its own; only `solve()` does, with
+`SolverUnavailableError`, if none of the above resolve.
+
+To build the library for a local checkout:
+
+```bash
+cmake -B build
+cmake --build build --config Release --target fitsolver_lib
+```
+
+## Building a wheel by hand
+
+```bash
+cmake --build build --config Release --target fitsolver_lib
+python python/fitsolver_client/tools/vendor_lib.py --build-dir build
+python -m build --wheel python/fitsolver_client
+# optional: normalise the tag to py3-none-<platform>
+python -m wheel tags --python-tag py3 --abi-tag none \
+  --platform-tag win_amd64 --remove python/fitsolver_client/dist/*.whl
+```
+
+## Usage
+
+```python
+import fitsolver_client
+
+response = fitsolver_client.solve({
+    "items": [
+        {"ItemCode": "ITM-001", "ItemReference": "Widget A",
+         "Width": 100, "Length": 200, "Depth": 50, "Weight": 1.0},
+    ],
+    "boxes": [
+        {"Reference": "SML", "Width": 150, "Length": 150, "Depth": 150,
+         "MaxWeight": 8.5},
+    ],
+})
+```
+
+See the FitSolver README's "Request / response JSON schema" section for the
+exact shape of the request and response dicts.

fitsolver_client-0.1.0/fitsolver_client.egg-info/SOURCES.txt

@@ -0,0 +1,8 @@
+README.md
+pyproject.toml
+setup.py
+fitsolver_client/__init__.py
+fitsolver_client.egg-info/PKG-INFO
+fitsolver_client.egg-info/SOURCES.txt
+fitsolver_client.egg-info/dependency_links.txt
+fitsolver_client.egg-info/top_level.txt

fitsolver_client-0.1.0/fitsolver_client.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

fitsolver_client-0.1.0/fitsolver_client.egg-info/top_level.txt

@@ -0,0 +1 @@
+fitsolver_client

fitsolver_client-0.1.0/pyproject.toml

@@ -0,0 +1,32 @@
+[project]
+name = "fitsolver-client"
+version = "0.1.0"
+description = "Minimal ctypes client for the FitSolver C ABI (fitsolver_lib)"
+readme = "README.md"
+requires-python = ">=3.9"
+dependencies = []
+authors = [{ name = "Fantastic Division" }]
+keywords = ["bin-packing", "packing", "fitsolver", "logistics"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Intended Audience :: Developers",
+    "Topic :: Scientific/Engineering",
+]
+
+[project.urls]
+Homepage = "https://github.com/FantasticDivision/Solver"
+Source = "https://github.com/FantasticDivision/Solver"
+
+[tool.setuptools]
+packages = ["fitsolver_client"]
+
+[tool.setuptools.package-data]
+# The native library is vendored here by the wheel build (tools/vendor_lib.py).
+# A source tree / editable install has no _libs/ dir and falls back to a
+# local build/ or FITSOLVER_LIB_PATH -- see fitsolver_client/__init__.py.
+fitsolver_client = ["_libs/*.dll", "_libs/*.so", "_libs/*.so.*", "_libs/*.dylib"]
+
+[build-system]
+requires = ["setuptools>=61", "wheel"]
+build-backend = "setuptools.build_meta"

fitsolver_client-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

fitsolver_client-0.1.0/setup.py

@@ -0,0 +1,23 @@
+"""Metadata lives in pyproject.toml; this shim exists only to force a
+platform-specific wheel tag.
+
+fitsolver-client is pure Python, but a built wheel vendors a native
+.dll/.so/.dylib under fitsolver_client/_libs/. Without this, setuptools
+would tag the wheel `py3-none-any` and pip on Linux would happily install
+the Windows binary. Declaring the distribution non-pure makes bdist_wheel
+emit `py3-none-<platform>` instead -- one wheel per OS, still valid for
+every Python 3.x (ctypes has no ABI dependency).
+
+An editable / sdist install builds no _libs/ dir and this is harmless.
+"""
+
+from setuptools import setup
+from setuptools.dist import Distribution
+
+
+class _BinaryDistribution(Distribution):
+    def has_ext_modules(self) -> bool:  # noqa: D102
+        return True
+
+
+setup(distclass=_BinaryDistribution)