# cvx-package-template
[](https://github.com/langestefan/cvx-package-template/actions/workflows/build.yml)
[](https://langestefan.github.io/cvx-package-template/)
[](https://codecov.io/gh/langestefan/cvx-package-template)
[](https://github.com/langestefan/cvx-package-template/blob/main/LICENSE)
[](https://pypi.org/project/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](https://github.com/astral-sh/uv) you will need:
```bash
uv sync --group dev
```
You can then run the tests using:
```bash
uv run pytest tests
```
Alternatively, with `pip` you can install the `dev` dependencies and run the tests using:
```bash
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:
```bash
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:
```bash
pip install -e .[dev,doc]
sphinx-autobuild docs/src docs/_build/html
```
## Repository description goes here.
The full documentation is available [here](https://www.cvxgrp.org/repository/).
If you wish to cite repository please cite the papers listed [here](https://www.cvxgrp.org/repository/citing).
Raw data
{
"_id": null,
"home_page": null,
"name": "cvx-package-template",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": "My Name <myname@place.com>",
"keywords": "convex optimization, cvxpy, mathematical programming",
"author": "Author 1, Author 2",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/9a/3e/4e961f2b0bf743dcefee42e69de4405c88f2896c74dbce49638f2c85d475/cvx_package_template-0.1.3.tar.gz",
"platform": null,
"description": "# cvx-package-template\n\n[](https://github.com/langestefan/cvx-package-template/actions/workflows/build.yml)\n[](https://langestefan.github.io/cvx-package-template/)\n[](https://codecov.io/gh/langestefan/cvx-package-template)\n[](https://github.com/langestefan/cvx-package-template/blob/main/LICENSE)\n[](https://pypi.org/project/cvx-package-template/)\n\n## Template instructions (to be removed)\n\nThis is a template for creating packages in the cvxpy ecosystem. It provides a basic\nstructure and configuration for a Python package, including:\n\n- A `pyproject.toml` file for package metadata and dependencies.\n- A `tests` directory for unit tests using `pytest` and `pytest-cov` for coverage\nreporting.\n- A `docs` directory for documentation using Sphinx.\n- A `examples` directory for example usage of the package, which will be displayed in\nthe documentation.\n- Linting and formatting using `ruff` and typechecking using `ty`.\n- Pre-commit hooks using `pre-commit` to ensure code quality before committing changes.\n\n## Running tests\n\nTo be able to run unit tests with [uv](https://github.com/astral-sh/uv) you will need:\n\n```bash\nuv sync --group dev\n```\n\nYou can then run the tests using:\n\n```bash\nuv run pytest tests\n```\n\nAlternatively, with `pip` you can install the `dev` dependencies and run the tests using:\n\n```bash\npip install -e .[dev]\npytest tests\n```\n\n## Building documentation locally\n\nTo build and run the documentation locally using `sphinx-autobuild`,\nyou need to first install dependencies using the following commands:\n\n```bash\nuv sync --group dev --group doc\nuv run sphinx-autobuild docs/src docs/_build/html\n```\n\nAlternatively, with `pip` you can install the `dev` and `doc` dependencies and run the documentation using:\n\n```bash\npip install -e .[dev,doc]\nsphinx-autobuild docs/src docs/_build/html\n```\n\n## Repository description goes here.\n\nThe full documentation is available [here](https://www.cvxgrp.org/repository/).\n\nIf you wish to cite repository please cite the papers listed [here](https://www.cvxgrp.org/repository/citing).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CVX package template for convex optimization projects.",
"version": "0.1.3",
"project_urls": {
"Bug Tracker": "https://github.com/langestefan/cvx-package-template/issues",
"Documentation": "https://github.com/langestefan/cvx-package-template",
"Homepage": "https://github.com/langestefan/cvx-package-template",
"Repository": "https://github.com/langestefan/cvx-package-template.git"
},
"split_keywords": [
"convex optimization",
" cvxpy",
" mathematical programming"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "1b976e010411405dffceb4090ba3568390be67c96681a25285dc94c4c6d508d3",
"md5": "f853d91f3dda01d1e61ff5afcb57a2b0",
"sha256": "a62fab94b23b38a8bb7b17b2056e4324617611a5bfcda8580254d81c1743e00d"
},
"downloads": -1,
"filename": "cvx_package_template-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f853d91f3dda01d1e61ff5afcb57a2b0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 5963,
"upload_time": "2025-08-07T14:46:03",
"upload_time_iso_8601": "2025-08-07T14:46:03.766557Z",
"url": "https://files.pythonhosted.org/packages/1b/97/6e010411405dffceb4090ba3568390be67c96681a25285dc94c4c6d508d3/cvx_package_template-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "9a3e4e961f2b0bf743dcefee42e69de4405c88f2896c74dbce49638f2c85d475",
"md5": "0d5fb7d85481d5dcbe1619f77945392b",
"sha256": "7d70986f8b5bbed8253bcc6fc096750968c4c1781e85f91a997c8fe2b18b4946"
},
"downloads": -1,
"filename": "cvx_package_template-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "0d5fb7d85481d5dcbe1619f77945392b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 11018,
"upload_time": "2025-08-07T14:46:05",
"upload_time_iso_8601": "2025-08-07T14:46:05.183374Z",
"url": "https://files.pythonhosted.org/packages/9a/3e/4e961f2b0bf743dcefee42e69de4405c88f2896c74dbce49638f2c85d475/cvx_package_template-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-07 14:46:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "langestefan",
"github_project": "cvx-package-template",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cvx-package-template"
}
JSON
