cvx-package-template 0.1.4

CVX package template for convex optimization projects.

cvx-package-template

Template instructions (to be removed)

This is a template for creating packages in the cvxpy ecosystem. It provides a basic structure and configuration for a Python package, including:

• A pyproject.toml file for package metadata and dependencies.
• A tests directory for unit tests using pytest and pytest-cov for coverage reporting.
• A docs directory for documentation using Sphinx.
• A examples directory for example usage of the package, which will be displayed in the documentation.
• Linting and formatting using ruff and typechecking using ty.
• Pre-commit hooks using pre-commit to ensure code quality before committing changes.

Running tests

To be able to run unit tests with uv you will need:

uv sync --group dev

You can then run the tests using:

uv run pytest tests

Alternatively, with pip you can install the dev dependencies and run the tests using:

pip install -e .[dev]
pytest tests

Building documentation locally

To build and run the documentation locally using sphinx-autobuild, you need to first install dependencies using the following commands:

uv sync --group dev --group doc
uv run sphinx-autobuild docs/src docs/_build/html

Alternatively, with pip you can install the dev and doc dependencies and run the documentation using:

pip install -e .[dev,doc]
sphinx-autobuild docs/src docs/_build/html

Repository description goes here.

The full documentation is available here.

If you wish to cite repository please cite the papers listed here.