blvpy 0.1.0__tar.gz

blvpy-0.1.0/.gitignore

@@ -0,0 +1,29 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+
+# uv / virtual environments
+.venv/
+.python-version
+
+# Test and analysis caches
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.coverage
+htmlcov/
+docs/_build/
+
+# Generated Marimo outputs and session state
+examples/figures/
+examples/__marimo__/
+
+# Editors and operating systems
+.DS_Store
+.idea/
+.vscode/
+*.swp
+*~

blvpy-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2026 Hao Zhu and blvpy contributors
+
+   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.

blvpy-0.1.0/PKG-INFO

@@ -0,0 +1,170 @@
+Metadata-Version: 2.5
+Name: blvpy
+Version: 0.1.0
+Summary: A Python package for disciplined bilevel programming.
+Project-URL: Repository, https://github.com/dxogrp/blvpy
+Project-URL: Documentation, https://dxogrp.github.io/blvpy/
+Author-email: Hao Zhu <zhuh@cs.uni-freiburg.de>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: CVXPY,bilevel optimization,convex optimization,disciplined nonlinear programming,disciplined parametrized programming
+Requires-Python: >=3.12
+Requires-Dist: cvxpy>=1.9
+Requires-Dist: cyipopt>=1.6
+Requires-Dist: numpy>=2.0
+Requires-Dist: scipy>=1.13
+Description-Content-Type: text/markdown
+
+# BLVPY: Disciplined Bilevel Programming
+
+BLVPY is a [CVXPY](https://www.cvxpy.org/) extension for modeling and locally solving optimistic bilevel optimization problems.
+A bilevel problem contains an optimization problem inside another optimization problem, i.e.,
+
+$$
+    \begin{array}{ll}
+        \text{minimize} & F_0(x, y)\\
+        \text{subject to} & F_i(x, y) \leq 0, \quad i = 1, \ldots, m\\
+        & y \in S(x),
+    \end{array}
+$$
+
+where $x \in \mathbf{R}^n$ contains the upper variables and $y \in \mathbf{R}^k$ contains lower variables constrained to belong to the set $S(x)$.
+For a fixed $x \in \mathbf{R}^n$, the constraint set $S(x)$ is defined as the solution set of the following lower problem:
+
+$$
+    \begin{array}{rl}
+      S(x) = \mathop{\rm argmin}_z & f_0(x, z)\\
+      \text{subject to} & f_i(x, z) \leq 0, \quad i = 1, \ldots, p.
+    \end{array}
+$$
+
+We say a bilevel problem is *disciplined bilevel programming* (DBP) compatible if it satisfies the following conditions:
+
+* The objective and constraint functions $F_i \colon \mathbf{R}^n \times \mathbf{R}^k \to \mathbf{R}$ for $i = 0, 1, \ldots, m$ of the upper problem are [DNLP](https://www.cvxpy.org/tutorial/dnlp/index.html)-compatible with variables $x \in \mathbf{R}^n$ and $y \in \mathbf{R}^k$.
+* The objective and constraint functions $f_i \colon \mathbf{R}^n \times \mathbf{R}^k \to \mathbf{R}$ for $i = 0, 1, \ldots, p$ of the lower problem are [DPP](https://www.cvxpy.org/tutorial/dpp/index.html)-compatible with variable $z \in \mathbf{R}^k$ (or $y \in \mathbf{R}^k$), so that the lower problem is a disciplined convex program, parameterized by $x \in \mathbf{R}^n$.
+
+BLVPY supports the modeling and solving of DBP-compliant problems and uses *optimistic semantics*, i.e., when the lower problem has multiple minimizers, the upper problem may select the one most favorable to its objective.
+
+## Basic idea
+
+BLVPY treats the upper variable $x$ as a parameter of the convex lower problem.
+When that lower problem satisfies DPP, BLVPY uses the CVXPY canonicalization backend to canonicalize the parameterized lower problem family into a cone program whose data depend affinely on $x$.
+
+BLVPY expresses optimality of the canonicalized lower problem through primal feasibility, dual feasibility, and the relaxed conic gap condition $s^T \lambda \leq \epsilon$.
+This produces a single-level problem, which BLVPY solves through CVXPY's nonlinear interface while warm-starting a sequence of problems with progressively smaller values of $\epsilon \to 0$.
+
+## Installation
+
+BLVPY requires:
+
+* Python 3.12 or newer;
+* CVXPY 1.9 or newer; and
+* a native [IPOPT](https://coin-or.github.io/Ipopt/INSTALL.html) installation.
+
+Install the native IPOPT library first following the [installation guide](https://coin-or.github.io/Ipopt/INSTALL.html).
+Then install BLVPY from PyPI:
+
+```shell
+pip install blvpy
+```
+
+CVXPY also exposes DNLP paths for KNITRO, UNO, and COPT; these solvers may be selected in BLVPY after proper installation, but are not tested officially.
+The required default (and recommended) nonlinear solver is IPOPT, which is free and open-source.
+[Clarabel](https://clarabel.org/stable/) is the default backend conic solver.
+
+### Development setup
+
+BLVPY manages its development environment with [uv](https://docs.astral.sh/uv/).
+Before setting up the repository, you should install uv and IPOPT.
+
+1. Clone the repository:
+
+   ```shell
+   git clone https://github.com/dxogrp/blvpy.git
+   cd blvpy
+   ```
+
+2. Create the virtual environment and install the locked development
+   dependencies:
+
+   ```shell
+   make sync
+   ```
+
+Run `make test` and `make lint` before contributing changes.
+
+## Quick start
+
+The following example models the bilevel problem
+
+$$
+\begin{array}{ll}
+\text{minimize} & (x-1)^2+(y+1)^2 \\
+\text{subject to} & x\geq -1, \\
+  & y\in\mathop{\mathrm{argmin}}_z (z-x)^2
+\end{array}
+$$
+
+with variables $x, y \in \mathbf{R}$.
+
+```python
+import cvxpy as cp
+import blvpy as bp
+
+# Use ordinary CVXPY variables in expressions at both levels.
+# Here, x is controlled by the upper problem and y by the lower problem.
+x = cp.Variable(name="x")
+y = cp.Variable(name="y")
+
+# Define the convex lower problem. Listing x in parameters means that x is
+# held fixed whenever the lower problem is solved.
+lower = bp.LowerProblem(
+    cp.Minimize(cp.square(y - x)),
+    parameters=[x],
+)
+
+# Define the upper objective and its constraints. The variable y is
+# shared with the lower problem, giving the upper problem access to its response.
+problem = bp.BilevelProblem(
+    cp.Minimize(cp.square(x - 1.0) + cp.square(y + 1.0)),
+    lower,
+    upper_constraints=[x >= -1.0],
+)
+
+# Check that BLVPY can construct its supported single-level reformulation.
+assert problem.is_dbp()
+problem.validate()
+
+# Solve the problem.
+result = problem.solve()
+
+# Optionally perform one additional lower solve for detailed gap diagnostics.
+diagnostics = problem.gap_diagnostics(result)
+```
+
+Every variable in `LowerProblem.parameters` is an upper-level variable and is replaced internally by a CVXPY parameter in the lower problem.
+Unlisted lower variables remain the original CVXPY objects, so the upper objective can use the returned lower solution directly.
+
+## Examples
+
+The [`examples`](examples) directory contains several [Marimo](https://marimo.io/) notebooks for demonstrating the use of BLVPY.
+Run
+
+```shell
+make marimo
+```
+
+to install Marimo and open the notebooks in your browser.
+
+## Documentation
+
+The complete user guide and API reference are available at [this page](https://dxogrp.github.io/blvpy/).
+To build and preview the Sphinx documentation locally, run:
+
+```shell
+make docs
+```
+
+## License
+
+BLVPY is licensed under the [Apache License 2.0](LICENSE).

blvpy-0.1.0/README.md

@@ -0,0 +1,153 @@
+# BLVPY: Disciplined Bilevel Programming
+
+BLVPY is a [CVXPY](https://www.cvxpy.org/) extension for modeling and locally solving optimistic bilevel optimization problems.
+A bilevel problem contains an optimization problem inside another optimization problem, i.e.,
+
+$$
+    \begin{array}{ll}
+        \text{minimize} & F_0(x, y)\\
+        \text{subject to} & F_i(x, y) \leq 0, \quad i = 1, \ldots, m\\
+        & y \in S(x),
+    \end{array}
+$$
+
+where $x \in \mathbf{R}^n$ contains the upper variables and $y \in \mathbf{R}^k$ contains lower variables constrained to belong to the set $S(x)$.
+For a fixed $x \in \mathbf{R}^n$, the constraint set $S(x)$ is defined as the solution set of the following lower problem:
+
+$$
+    \begin{array}{rl}
+      S(x) = \mathop{\rm argmin}_z & f_0(x, z)\\
+      \text{subject to} & f_i(x, z) \leq 0, \quad i = 1, \ldots, p.
+    \end{array}
+$$
+
+We say a bilevel problem is *disciplined bilevel programming* (DBP) compatible if it satisfies the following conditions:
+
+* The objective and constraint functions $F_i \colon \mathbf{R}^n \times \mathbf{R}^k \to \mathbf{R}$ for $i = 0, 1, \ldots, m$ of the upper problem are [DNLP](https://www.cvxpy.org/tutorial/dnlp/index.html)-compatible with variables $x \in \mathbf{R}^n$ and $y \in \mathbf{R}^k$.
+* The objective and constraint functions $f_i \colon \mathbf{R}^n \times \mathbf{R}^k \to \mathbf{R}$ for $i = 0, 1, \ldots, p$ of the lower problem are [DPP](https://www.cvxpy.org/tutorial/dpp/index.html)-compatible with variable $z \in \mathbf{R}^k$ (or $y \in \mathbf{R}^k$), so that the lower problem is a disciplined convex program, parameterized by $x \in \mathbf{R}^n$.
+
+BLVPY supports the modeling and solving of DBP-compliant problems and uses *optimistic semantics*, i.e., when the lower problem has multiple minimizers, the upper problem may select the one most favorable to its objective.
+
+## Basic idea
+
+BLVPY treats the upper variable $x$ as a parameter of the convex lower problem.
+When that lower problem satisfies DPP, BLVPY uses the CVXPY canonicalization backend to canonicalize the parameterized lower problem family into a cone program whose data depend affinely on $x$.
+
+BLVPY expresses optimality of the canonicalized lower problem through primal feasibility, dual feasibility, and the relaxed conic gap condition $s^T \lambda \leq \epsilon$.
+This produces a single-level problem, which BLVPY solves through CVXPY's nonlinear interface while warm-starting a sequence of problems with progressively smaller values of $\epsilon \to 0$.
+
+## Installation
+
+BLVPY requires:
+
+* Python 3.12 or newer;
+* CVXPY 1.9 or newer; and
+* a native [IPOPT](https://coin-or.github.io/Ipopt/INSTALL.html) installation.
+
+Install the native IPOPT library first following the [installation guide](https://coin-or.github.io/Ipopt/INSTALL.html).
+Then install BLVPY from PyPI:
+
+```shell
+pip install blvpy
+```
+
+CVXPY also exposes DNLP paths for KNITRO, UNO, and COPT; these solvers may be selected in BLVPY after proper installation, but are not tested officially.
+The required default (and recommended) nonlinear solver is IPOPT, which is free and open-source.
+[Clarabel](https://clarabel.org/stable/) is the default backend conic solver.
+
+### Development setup
+
+BLVPY manages its development environment with [uv](https://docs.astral.sh/uv/).
+Before setting up the repository, you should install uv and IPOPT.
+
+1. Clone the repository:
+
+   ```shell
+   git clone https://github.com/dxogrp/blvpy.git
+   cd blvpy
+   ```
+
+2. Create the virtual environment and install the locked development
+   dependencies:
+
+   ```shell
+   make sync
+   ```
+
+Run `make test` and `make lint` before contributing changes.
+
+## Quick start
+
+The following example models the bilevel problem
+
+$$
+\begin{array}{ll}
+\text{minimize} & (x-1)^2+(y+1)^2 \\
+\text{subject to} & x\geq -1, \\
+  & y\in\mathop{\mathrm{argmin}}_z (z-x)^2
+\end{array}
+$$
+
+with variables $x, y \in \mathbf{R}$.
+
+```python
+import cvxpy as cp
+import blvpy as bp
+
+# Use ordinary CVXPY variables in expressions at both levels.
+# Here, x is controlled by the upper problem and y by the lower problem.
+x = cp.Variable(name="x")
+y = cp.Variable(name="y")
+
+# Define the convex lower problem. Listing x in parameters means that x is
+# held fixed whenever the lower problem is solved.
+lower = bp.LowerProblem(
+    cp.Minimize(cp.square(y - x)),
+    parameters=[x],
+)
+
+# Define the upper objective and its constraints. The variable y is
+# shared with the lower problem, giving the upper problem access to its response.
+problem = bp.BilevelProblem(
+    cp.Minimize(cp.square(x - 1.0) + cp.square(y + 1.0)),
+    lower,
+    upper_constraints=[x >= -1.0],
+)
+
+# Check that BLVPY can construct its supported single-level reformulation.
+assert problem.is_dbp()
+problem.validate()
+
+# Solve the problem.
+result = problem.solve()
+
+# Optionally perform one additional lower solve for detailed gap diagnostics.
+diagnostics = problem.gap_diagnostics(result)
+```
+
+Every variable in `LowerProblem.parameters` is an upper-level variable and is replaced internally by a CVXPY parameter in the lower problem.
+Unlisted lower variables remain the original CVXPY objects, so the upper objective can use the returned lower solution directly.
+
+## Examples
+
+The [`examples`](examples) directory contains several [Marimo](https://marimo.io/) notebooks for demonstrating the use of BLVPY.
+Run
+
+```shell
+make marimo
+```
+
+to install Marimo and open the notebooks in your browser.
+
+## Documentation
+
+The complete user guide and API reference are available at [this page](https://dxogrp.github.io/blvpy/).
+To build and preview the Sphinx documentation locally, run:
+
+```shell
+make docs
+```
+
+## License
+
+BLVPY is licensed under the [Apache License 2.0](LICENSE).

blvpy-0.1.0/pyproject.toml

@@ -0,0 +1,65 @@
+[project]
+name = "blvpy"
+version = "0.1.0"
+description = "A Python package for disciplined bilevel programming."
+readme = "README.md"
+license = "Apache-2.0"
+authors = [
+    { name = "Hao Zhu", email = "zhuh@cs.uni-freiburg.de" },
+]
+keywords = [
+    "bilevel optimization",
+    "convex optimization",
+    "disciplined parametrized programming",
+    "disciplined nonlinear programming",
+    "CVXPY",
+]
+requires-python = ">=3.12"
+dependencies = [
+    "cyipopt>=1.6",
+    "cvxpy>=1.9",
+    "numpy>=2.0",
+    "scipy>=1.13",
+]
+
+[project.urls]
+Repository = "https://github.com/dxogrp/blvpy"
+Documentation = "https://dxogrp.github.io/blvpy/"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/blvpy"]
+
+[tool.hatch.build.targets.sdist]
+only-include = [
+    "src/blvpy",
+    "README.md",
+    "LICENSE",
+    "pyproject.toml",
+]
+
+[dependency-groups]
+dev = [
+    "packaging>=25",
+    "pytest>=8.4",
+    "ruff>=0.12",
+]
+examples = [
+    "marimo>=0.23",
+    "matplotlib>=3.9",
+]
+docs = [
+    "alabaster>=1,<2",
+    "myst-parser>=5.1,<6",
+    "sphinx>=9.1,<10",
+]
+
+[tool.ruff]
+line-length = 120
+target-version = "py312"
+
+[tool.ruff.lint]
+select = ["E", "F", "I"]

blvpy-0.1.0/src/blvpy/__init__.py

@@ -0,0 +1,58 @@
+"""BLVPY: disciplined optimistic bilevel optimization with CVXPY."""
+
+from importlib.metadata import version as _distribution_version
+
+from .canonicalization import (
+    AffineRecoveryMap,
+    CanonicalData,
+    CanonicalExpressions,
+    CanonicalLowerProblem,
+    ParameterSpec,
+    RecoverySpec,
+)
+from .cones import ConeBlock, ConeLayout
+from .errors import (
+    ApproximateCanonicalizationError,
+    BilevelError,
+    CanonicalizationError,
+    InitializationError,
+    ParameterMappingError,
+    SolveError,
+    SolverUnavailableError,
+    UnsupportedConeError,
+    UnsupportedModelError,
+    ValidationError,
+)
+from .lower_problem import LowerProblem
+from .problem import BilevelProblem
+from .result import BilevelResult, GapDiagnostics, IterationRecord, Residuals, RunRecord
+
+__all__ = [
+    "ApproximateCanonicalizationError",
+    "AffineRecoveryMap",
+    "BilevelError",
+    "BilevelProblem",
+    "BilevelResult",
+    "CanonicalData",
+    "CanonicalExpressions",
+    "CanonicalLowerProblem",
+    "CanonicalizationError",
+    "ConeBlock",
+    "ConeLayout",
+    "GapDiagnostics",
+    "InitializationError",
+    "IterationRecord",
+    "LowerProblem",
+    "ParameterMappingError",
+    "ParameterSpec",
+    "RecoverySpec",
+    "Residuals",
+    "RunRecord",
+    "SolveError",
+    "SolverUnavailableError",
+    "UnsupportedConeError",
+    "UnsupportedModelError",
+    "ValidationError",
+]
+
+__version__ = _distribution_version("blvpy")