primalsolver 0.1.0__tar.gz

primalsolver-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.

primalsolver-0.1.0/MANIFEST.in

@@ -0,0 +1,10 @@
+# sdist contents. The C sources come from the vendored csrc/ snapshot
+# (run sync_csrc.py before building a release), so the sdist is self-contained.
+include LICENSE README.md pyproject.toml setup.py sync_csrc.py MANIFEST.in
+graft csrc
+
+# never ship a pre-built, platform-specific library in the sdist
+exclude src/primalsolver/_lib/*.dylib
+exclude src/primalsolver/_lib/*.so
+exclude src/primalsolver/_lib/*.dll
+global-exclude __pycache__ *.pyc

primalsolver-0.1.0/PKG-INFO

@@ -0,0 +1,243 @@
+Metadata-Version: 2.4
+Name: primalsolver
+Version: 0.1.0
+Summary: PrimalSolver: dependency-free convex optimization (LP/QP/SOCP/SDP/exp-power/MIP) in C99, callable from Python via ctypes.
+Author: Gaetano Minardi
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/c-vision/Primal
+Keywords: optimization,linear-programming,quadratic-programming,socp,sdp,conic,mip,ctypes
+Classifier: Programming Language :: C
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# primalsolver
+
+Python bindings for **PrimalSolver** — a dependency-free convex optimization
+solver in C99 (LP / QP / SOCP / SDP / exp-power / MIP).
+
+The package ships a pre-built shared library (`libprimal.dylib` / `.so` / `.dll`)
+inside the wheel and calls it through `ctypes`: no C toolchain is needed to
+install, and the whole public API is exposed.
+
+> Upstream C library: <https://github.com/c-vision/Primal>. This package treats
+> its sources as read-only input and never modifies them.
+
+```python
+from primalsolver import Model, BK, SOLSTA
+
+with Model(maxcon=2, maxvar=2) as m:
+    m.obj([0, 1], [-3.0, -2.0])           # min -3 x0 - 2 x1
+    m.a_ij(0, 0, 1.0); m.a_ij(0, 1, 1.0)  # x0 +  x1 <= 4
+    m.a_ij(1, 0, 1.0); m.a_ij(1, 1, 3.0)  # x0 + 3x1 <= 6
+    m.con_bounds(0, BK.UP, up=4.0)
+    m.con_bounds(1, BK.UP, up=6.0)
+    m.var_bounds(0, BK.RA, 0.0, 3.0)      # 0 <= x0 <= 3
+    m.var_bounds(1, BK.RA, 0.0, 3.0)
+    r = m.solve()
+
+assert r.solsta == SOLSTA.OPTIMAL
+print(r.x, r.objective)                    # [3.0, 1.0] -11.0
+```
+
+## Requirements
+
+- Python >= 3.8, **no runtime dependencies** other than the standard library.
+- A platform wheel is provided per OS/arch (macOS, Linux, Windows). On a platform
+  without a wheel you can build from source (see below).
+
+## Install
+
+```sh
+pip install primalsolver
+```
+
+Verify:
+
+```sh
+python -c "import primalsolver as ps; print(ps.version())"
+```
+
+## Quickstart
+
+Build and solve a model in code (above), or solve a **model file** — MPS, CPLEX
+LP, OPF and CBF are auto-detected by content/extension:
+
+```python
+from primalsolver import Model, SOLSTA
+
+with Model() as m:
+    m.read("model.mps")
+    r = m.solve()
+
+print(r.solsta, r.x, r.objective)
+```
+
+The high-level `Model` covers the common path. Everything else is reachable
+through the generated low-level binding.
+
+## Full API (all 547 functions)
+
+`tools/gen_bindings.py` parses the C header `primal.h` and emits
+`src/primalsolver/_bindings.py` with a ctypes signature for **every** `PRIMAL_*`
+function. `_native.py` applies them and re-exports them, so the entire surface is
+available:
+
+```python
+import primalsolver as ps
+
+ps.PRIMAL_getdualray(...)      # every PRIMAL_* is available at package level
+ps.FUNCTIONS                    # name -> ctypes function object (547)
+ps.MISSING                      # declared in the header but absent in the lib (empty = OK)
+ps._native.optimize             # short aliases (PRIMAL_ removed) used by Model
+```
+
+Handles (`PRIMALenv_t` / `PRIMALtask_t`) are opaque C pointers: the functions
+that create/destroy them take a *pointer to the handle*, so pass
+`ctypes.byref(...)`. Callback arguments are exposed as `c_void_p`; the two
+variadic functions (`PRIMAL_echotask`, `PRIMAL_echoenv`) are exposed without
+`argtypes` (ctypes cannot type C varargs) — pass explicit ctypes objects for the
+extra arguments.
+
+Regenerate the binding **after any change to `primal.h`**:
+
+```sh
+python tools/gen_bindings.py
+```
+
+## What is shipped
+
+- **Wheel**: only the `primalsolver` package — `__init__.py`, `_native.py`, the
+  generated `_bindings.py`, the compiled library in `_lib/`, plus `README.md` and
+  `LICENSE`.
+- **Python examples** live in `../python_examples/` (tracked in the C repository),
+  not in this package. No test files are shipped.
+
+## Building from source
+
+The C sources are **read-only input**; this project never modifies them. `setup.py`
+compiles the shared library into `src/primalsolver/_lib/` before packaging.
+
+Source directory resolution, in order:
+
+1. `$PRIMAL_C_SRC` — an explicit C checkout;
+2. `csrc/` — a vendored snapshot (`python sync_csrc.py`), used by the sdist/CI;
+3. `..` — the parent directory, i.e. the live C repository (default).
+
+`csrc/` is generated by `sync_csrc.py` and is **gitignored**: the C sources have
+a single home in the C repository. CI fetches them from
+`github.com/c-vision/Primal` and regenerates `csrc/` before building.
+
+Development install:
+
+```sh
+python -m venv .venv && . .venv/bin/activate
+pip install -U pip setuptools wheel
+pip install -e .
+python -c "import primalsolver as ps; print(ps.version())"
+```
+
+Build a wheel locally (needs only `setuptools` + `wheel`, no `build` package):
+
+```sh
+python -m pip wheel . --no-build-isolation --no-deps -w dist
+```
+
+> The wheel bundles a native library, so it is **platform-specific**:
+> `py3-none-<platform>` (e.g. `py3-none-macosx_11_0_arm64`), never `none-any`.
+
+## Building the distribution wheels (all platforms)
+
+Config lives in `[tool.cibuildwheel]` (`pyproject.toml`); `cibuildwheel`
+compiles inside each target environment (required for manylinux) and runs
+`auditwheel` / `delocate`. In CI the C sources are fetched from
+`github.com/c-vision/Primal` and vendored with `sync_csrc.py` before building
+(see `.github/workflows/wheels.yml`).
+
+```sh
+pip install cibuildwheel
+python -m cibuildwheel --output-dir dist        # current platform
+python -m cibuildwheel --platform <os> --output-dir dist
+```
+
+Notes:
+
+- macOS: set `MACOSX_DEPLOYMENT_TARGET` (e.g. `11.0`) for older systems and
+  codesign the dylib (`codesign -s -`); `cibuildwheel` handles `delocate`.
+- Windows: built with mingw-w64 (`before-all = "choco install -y mingw"`) and
+  `-static` so the DLL is standalone.
+- Linux: `-pthread` is linked (manylinux glibc < 2.34 keeps pthread in
+  `libpthread`).
+
+## Release procedure
+
+1. **Generate the vendored snapshot** (makes the sdist self-contained; it is
+   gitignored, not committed):
+
+   ```sh
+   python sync_csrc.py
+   ```
+
+2. **Regenerate the binding** if `primal.h` changed:
+
+   ```sh
+   python tools/gen_bindings.py
+   ```
+
+3. **Bump the version** — the single source of truth is `__version__` in
+   `src/primalsolver/__init__.py` (`pyproject.toml` reads it via
+   `dynamic = ["version"]`).
+
+4. **Check locally**:
+
+   ```sh
+   pip install -e .
+   python -c "import primalsolver as ps; print(ps.version())"
+   python -m pip wheel . --no-build-isolation --no-deps -w dist
+   ```
+
+5. **Commit and tag** (in the Python repository, never the C one):
+
+   ```sh
+   git add -A && git commit -m "release vX.Y.Z"
+   git tag vX.Y.Z
+   git push origin main --tags
+   ```
+
+6. **Publish**: a Git **tag** triggers `.github/workflows/wheels.yml`, which
+   builds the wheels + sdist and uploads them as artifacts. Publishing to PyPI
+   runs only when a **GitHub Release** is published for that tag, using
+   **trusted publishing** (OIDC, no API token stored).
+
+   Prerequisites (one-time): register a PyPI *trusted publisher* for this
+   repository and create a `pypi` environment in the GitHub repo settings.
+
+   Manual/fallback publish (e.g. TestPyPI):
+
+   ```sh
+   pip install build twine
+   python -m build
+   twine check dist/*
+   twine upload --repository testpypi dist/*   # then: twine upload dist/*
+   ```
+
+## Repository layout
+
+```
+pyproject.toml          # metadata + cibuildwheel config
+setup.py                # compiles the shared lib; forces the platform wheel tag
+MANIFEST.in             # sdist contents (vendored csrc, no prebuilt binaries)
+sync_csrc.py            # vendored C-source snapshot -> csrc/
+tools/gen_bindings.py   # primal.h -> src/primalsolver/_bindings.py (547 fns)
+csrc/                   # C-source snapshot (generated by sync_csrc.py; gitignored)
+src/primalsolver/       # the installed package (__init__, _native, _bindings, _lib)
+.github/workflows/wheels.yml
+```
+
+## License
+
+Apache-2.0, same as PrimalSolver. See `LICENSE`.

primalsolver-0.1.0/README.md

@@ -0,0 +1,226 @@
+# primalsolver
+
+Python bindings for **PrimalSolver** — a dependency-free convex optimization
+solver in C99 (LP / QP / SOCP / SDP / exp-power / MIP).
+
+The package ships a pre-built shared library (`libprimal.dylib` / `.so` / `.dll`)
+inside the wheel and calls it through `ctypes`: no C toolchain is needed to
+install, and the whole public API is exposed.
+
+> Upstream C library: <https://github.com/c-vision/Primal>. This package treats
+> its sources as read-only input and never modifies them.
+
+```python
+from primalsolver import Model, BK, SOLSTA
+
+with Model(maxcon=2, maxvar=2) as m:
+    m.obj([0, 1], [-3.0, -2.0])           # min -3 x0 - 2 x1
+    m.a_ij(0, 0, 1.0); m.a_ij(0, 1, 1.0)  # x0 +  x1 <= 4
+    m.a_ij(1, 0, 1.0); m.a_ij(1, 1, 3.0)  # x0 + 3x1 <= 6
+    m.con_bounds(0, BK.UP, up=4.0)
+    m.con_bounds(1, BK.UP, up=6.0)
+    m.var_bounds(0, BK.RA, 0.0, 3.0)      # 0 <= x0 <= 3
+    m.var_bounds(1, BK.RA, 0.0, 3.0)
+    r = m.solve()
+
+assert r.solsta == SOLSTA.OPTIMAL
+print(r.x, r.objective)                    # [3.0, 1.0] -11.0
+```
+
+## Requirements
+
+- Python >= 3.8, **no runtime dependencies** other than the standard library.
+- A platform wheel is provided per OS/arch (macOS, Linux, Windows). On a platform
+  without a wheel you can build from source (see below).
+
+## Install
+
+```sh
+pip install primalsolver
+```
+
+Verify:
+
+```sh
+python -c "import primalsolver as ps; print(ps.version())"
+```
+
+## Quickstart
+
+Build and solve a model in code (above), or solve a **model file** — MPS, CPLEX
+LP, OPF and CBF are auto-detected by content/extension:
+
+```python
+from primalsolver import Model, SOLSTA
+
+with Model() as m:
+    m.read("model.mps")
+    r = m.solve()
+
+print(r.solsta, r.x, r.objective)
+```
+
+The high-level `Model` covers the common path. Everything else is reachable
+through the generated low-level binding.
+
+## Full API (all 547 functions)
+
+`tools/gen_bindings.py` parses the C header `primal.h` and emits
+`src/primalsolver/_bindings.py` with a ctypes signature for **every** `PRIMAL_*`
+function. `_native.py` applies them and re-exports them, so the entire surface is
+available:
+
+```python
+import primalsolver as ps
+
+ps.PRIMAL_getdualray(...)      # every PRIMAL_* is available at package level
+ps.FUNCTIONS                    # name -> ctypes function object (547)
+ps.MISSING                      # declared in the header but absent in the lib (empty = OK)
+ps._native.optimize             # short aliases (PRIMAL_ removed) used by Model
+```
+
+Handles (`PRIMALenv_t` / `PRIMALtask_t`) are opaque C pointers: the functions
+that create/destroy them take a *pointer to the handle*, so pass
+`ctypes.byref(...)`. Callback arguments are exposed as `c_void_p`; the two
+variadic functions (`PRIMAL_echotask`, `PRIMAL_echoenv`) are exposed without
+`argtypes` (ctypes cannot type C varargs) — pass explicit ctypes objects for the
+extra arguments.
+
+Regenerate the binding **after any change to `primal.h`**:
+
+```sh
+python tools/gen_bindings.py
+```
+
+## What is shipped
+
+- **Wheel**: only the `primalsolver` package — `__init__.py`, `_native.py`, the
+  generated `_bindings.py`, the compiled library in `_lib/`, plus `README.md` and
+  `LICENSE`.
+- **Python examples** live in `../python_examples/` (tracked in the C repository),
+  not in this package. No test files are shipped.
+
+## Building from source
+
+The C sources are **read-only input**; this project never modifies them. `setup.py`
+compiles the shared library into `src/primalsolver/_lib/` before packaging.
+
+Source directory resolution, in order:
+
+1. `$PRIMAL_C_SRC` — an explicit C checkout;
+2. `csrc/` — a vendored snapshot (`python sync_csrc.py`), used by the sdist/CI;
+3. `..` — the parent directory, i.e. the live C repository (default).
+
+`csrc/` is generated by `sync_csrc.py` and is **gitignored**: the C sources have
+a single home in the C repository. CI fetches them from
+`github.com/c-vision/Primal` and regenerates `csrc/` before building.
+
+Development install:
+
+```sh
+python -m venv .venv && . .venv/bin/activate
+pip install -U pip setuptools wheel
+pip install -e .
+python -c "import primalsolver as ps; print(ps.version())"
+```
+
+Build a wheel locally (needs only `setuptools` + `wheel`, no `build` package):
+
+```sh
+python -m pip wheel . --no-build-isolation --no-deps -w dist
+```
+
+> The wheel bundles a native library, so it is **platform-specific**:
+> `py3-none-<platform>` (e.g. `py3-none-macosx_11_0_arm64`), never `none-any`.
+
+## Building the distribution wheels (all platforms)
+
+Config lives in `[tool.cibuildwheel]` (`pyproject.toml`); `cibuildwheel`
+compiles inside each target environment (required for manylinux) and runs
+`auditwheel` / `delocate`. In CI the C sources are fetched from
+`github.com/c-vision/Primal` and vendored with `sync_csrc.py` before building
+(see `.github/workflows/wheels.yml`).
+
+```sh
+pip install cibuildwheel
+python -m cibuildwheel --output-dir dist        # current platform
+python -m cibuildwheel --platform <os> --output-dir dist
+```
+
+Notes:
+
+- macOS: set `MACOSX_DEPLOYMENT_TARGET` (e.g. `11.0`) for older systems and
+  codesign the dylib (`codesign -s -`); `cibuildwheel` handles `delocate`.
+- Windows: built with mingw-w64 (`before-all = "choco install -y mingw"`) and
+  `-static` so the DLL is standalone.
+- Linux: `-pthread` is linked (manylinux glibc < 2.34 keeps pthread in
+  `libpthread`).
+
+## Release procedure
+
+1. **Generate the vendored snapshot** (makes the sdist self-contained; it is
+   gitignored, not committed):
+
+   ```sh
+   python sync_csrc.py
+   ```
+
+2. **Regenerate the binding** if `primal.h` changed:
+
+   ```sh
+   python tools/gen_bindings.py
+   ```
+
+3. **Bump the version** — the single source of truth is `__version__` in
+   `src/primalsolver/__init__.py` (`pyproject.toml` reads it via
+   `dynamic = ["version"]`).
+
+4. **Check locally**:
+
+   ```sh
+   pip install -e .
+   python -c "import primalsolver as ps; print(ps.version())"
+   python -m pip wheel . --no-build-isolation --no-deps -w dist
+   ```
+
+5. **Commit and tag** (in the Python repository, never the C one):
+
+   ```sh
+   git add -A && git commit -m "release vX.Y.Z"
+   git tag vX.Y.Z
+   git push origin main --tags
+   ```
+
+6. **Publish**: a Git **tag** triggers `.github/workflows/wheels.yml`, which
+   builds the wheels + sdist and uploads them as artifacts. Publishing to PyPI
+   runs only when a **GitHub Release** is published for that tag, using
+   **trusted publishing** (OIDC, no API token stored).
+
+   Prerequisites (one-time): register a PyPI *trusted publisher* for this
+   repository and create a `pypi` environment in the GitHub repo settings.
+
+   Manual/fallback publish (e.g. TestPyPI):
+
+   ```sh
+   pip install build twine
+   python -m build
+   twine check dist/*
+   twine upload --repository testpypi dist/*   # then: twine upload dist/*
+   ```
+
+## Repository layout
+
+```
+pyproject.toml          # metadata + cibuildwheel config
+setup.py                # compiles the shared lib; forces the platform wheel tag
+MANIFEST.in             # sdist contents (vendored csrc, no prebuilt binaries)
+sync_csrc.py            # vendored C-source snapshot -> csrc/
+tools/gen_bindings.py   # primal.h -> src/primalsolver/_bindings.py (547 fns)
+csrc/                   # C-source snapshot (generated by sync_csrc.py; gitignored)
+src/primalsolver/       # the installed package (__init__, _native, _bindings, _lib)
+.github/workflows/wheels.yml
+```
+
+## License
+
+Apache-2.0, same as PrimalSolver. See `LICENSE`.