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.
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
pip install primalsolver
Verify:
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:
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:
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:
python tools/gen_bindings.py
What is shipped
- Wheel: only the
primalsolverpackage —__init__.py,_native.py, the generated_bindings.py, the compiled library in_lib/, plusREADME.mdandLICENSE. - Python examples live in
../examples/python/(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:
$PRIMAL_C_SRC— an explicit C checkout;csrc/— a vendored snapshot (python sync_csrc.py), used by the sdist/CI;..— 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:
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):
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), nevernone-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).
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 -);cibuildwheelhandlesdelocate. - Windows: built with mingw-w64 (
before-all = "choco install -y mingw") and-staticso the DLL is standalone. - Linux:
-pthreadis linked (manylinux glibc < 2.34 keeps pthread inlibpthread).
Release procedure
-
Generate the vendored snapshot (makes the sdist self-contained; it is gitignored, not committed):
python sync_csrc.py -
Regenerate the binding if
primal.hchanged:python tools/gen_bindings.py -
Bump the version — the single source of truth is
__version__insrc/primalsolver/__init__.py(pyproject.tomlreads it viadynamic = ["version"]). -
Check locally:
pip install -e . python -c "import primalsolver as ps; print(ps.version())" python -m pip wheel . --no-build-isolation --no-deps -w dist
-
Commit and tag (in the Python repository, never the C one):
git add -A && git commit -m "release vX.Y.Z" git tag vX.Y.Z git push origin main --tags
-
Publish: pushing a tag
vX.Y.Ztriggers.github/workflows/wheels.yml, which builds the wheels + sdist and uploads them as artifacts. Publishing to PyPI runs when a GitHub Release is published for that tag, using the repository secretPYPI_API_TOKEN(token auth).Prerequisites (one-time): add
PYPI_API_TOKENin the repo (Settings → Secrets and variables → Actions) with the PyPI API token.Manual/fallback publish (e.g. TestPyPI):
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.
Metadata
Release files for primalsolver 0.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| primalsolver-0.1.3.tar.gz | 473.5 kB | Without provenance | Details for primalsolver-0.1.3.tar.gz |
Built distributions (wheels)
| File | Actions Reset | |||
|---|---|---|---|---|
| primalsolver-0.1.3-py3-none-win_amd64.whl | Python 3 | none | Windows x86-64 | Details for primalsolver-0.1.3-py3-none-win_amd64.whl |
| primalsolver-0.1.3-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl | Python 3 | none | Linux glibc 2.17+ x86-64 | Details for primalsolver-0.1.3-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
| primalsolver-0.1.3-py3-none-macosx_11_0_arm64.whl | Python 3 | none | macOS 11.0+ ARM64 | Details for primalsolver-0.1.3-py3-none-macosx_11_0_arm64.whl |
| primalsolver-0.1.3-py3-none-macosx_10_13_x86_64.whl | Python 3 | none | macOS 10.13+ x86-64 | Details for primalsolver-0.1.3-py3-none-macosx_10_13_x86_64.whl |
Total release size: 3.1 MB
Release files / primalsolver-0.1.3.tar.gz
| Download URL | primalsolver-0.1.3.tar.gz |
|---|---|
| Size | 473.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7a85e138bca85aebf188d0fd3fe948e7b4c85bc941f89c13319f000adab99f30
|
|
BLAKE2b-256 checksum How to use checksums |
2efe044aae1c392696f6c9937c2eaaaa036b60acf92d7868f2838d691f8be6a9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Release files / primalsolver-0.1.3-py3-none-win_amd64.whl
| Download URL | primalsolver-0.1.3-py3-none-win_amd64.whl |
|---|---|
| Size | 475.9 kB |
| Tags | Python 3 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
e88ab40391995bcc123c2ad4de5bbccd984aaa2114d4936e1794938442d6be37
|
|
BLAKE2b-256 checksum How to use checksums |
031cd3ac66a5e66a5fa6abe22914e4f8e74708c27f61a88a0f48315d4eb832ec
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Release files / primalsolver-0.1.3-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | primalsolver-0.1.3-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 415.8 kB |
| Tags | Linux glibc 2.17+ x86-64 Python 3 |
|
SHA-256 checksum How to use checksums |
6dafd7bb7a66380a06f3a8840996a3c46345f6f562fed6b0a5e986f8a4a31631
|
|
BLAKE2b-256 checksum How to use checksums |
43ce96899a1d61019ef96e01ae88c101528a02664be548b906e785d41710990c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Release files / primalsolver-0.1.3-py3-none-macosx_11_0_arm64.whl
| Download URL | primalsolver-0.1.3-py3-none-macosx_11_0_arm64.whl |
|---|---|
| Size | 858.0 kB |
| Tags | Python 3 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
00e2fdbf430fbec1e76e744d35e9069eb5bb2e07611b117f4474e0f925e69d25
|
|
BLAKE2b-256 checksum How to use checksums |
ea03aabc77902691453160597a977faca3fcc13142bd2bc76b5afba013093083
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Release files / primalsolver-0.1.3-py3-none-macosx_10_13_x86_64.whl
| Download URL | primalsolver-0.1.3-py3-none-macosx_10_13_x86_64.whl |
|---|---|
| Size | 857.8 kB |
| Tags | Python 3 macOS 10.13+ x86-64 |
|
SHA-256 checksum How to use checksums |
3f8035b38b059ba52e8d6af4bff47a4405f130a7e1dddfe1d0a85771049c862f
|
|
BLAKE2b-256 checksum How to use checksums |
c5edceaa9a84f93b56d77911fbdf315b7774b0cee49ab295ed1cea066837e2ac
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Security for primalsolver 0.1.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.