diff --git a/.github/workflows/quantlib-risks.yml b/.github/workflows/quantlib-risks.yml index afd39f8d..a240b18f 100644 --- a/.github/workflows/quantlib-risks.yml +++ b/.github/workflows/quantlib-risks.yml @@ -10,7 +10,7 @@ # - publish to Test PyPI worked (with all build conditions above) # - and if it's a version tag (starting with v*) # -# cibuildwheel config: [tool.cibuildwheel] in pyproject.toml; shim/ is built alongside +# cibuildwheel config: [tool.cibuildwheel] in pyproject.toml name: QuantLibAAD wheels on: @@ -110,26 +110,8 @@ jobs: path: dist/*.tar.gz if-no-files-found: error - build_shim: - name: QuantLib-Risks shim - runs-on: ubuntu-24.04 - steps: - - uses: actions/checkout@v7 - with: - persist-credentials: false - - name: Build sdist and wheel - run: pipx run build --outdir dist shim - - name: Check metadata - run: pipx run twine check --strict dist/* - - name: Upload shim - uses: actions/upload-artifact@v7 - with: - name: dist-shim - path: dist/* - if-no-files-found: error - test-publish: - needs: [build_wheels, build_sdist, build_shim] + needs: [build_wheels, build_sdist] if: >- github.repository == 'auto-differentiation/QuantLibAAD-Py' && (github.event_name == 'workflow_dispatch' || diff --git a/CHANGELOG.md b/CHANGELOG.md index c94fd5c7..0d9cecaa 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,10 +9,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +### Removed + +- The `QuantLib-Risks` alias package is no longer built: `QuantLib-Risks` 1.44.0 stays on PyPI as + its last release; install `QuantLibAAD` instead + ### Added - Colab notebooks in `notebooks/`: option Greeks and curve risk in one adjoint sweep + ## [1.44.0] - 2026-11-12 First release as QuantLibAAD. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f829afcb..bca8245d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -88,9 +88,6 @@ Notes: - Wheels for all supported Python versions are built with [cibuildwheel](https://cibuildwheel.pypa.io) (`pipx run cibuildwheel`, configured in `pyproject.toml`), the source distribution with `pipx run build --sdist`. -- `shim/` is the pure-Python `QuantLib-Risks` distribution, a deprecated alias that requires - `QuantLibAAD` and re-exports it as `QuantLib_Risks`. Build it with `pipx run build shim` - and keep its version and `QuantLibAAD` requirement in sync with `pyproject.toml`. [pr]: https://github.com/auto-differentiation/QuantLibAAD-Py/compare/ diff --git a/Python/README.md b/Python/README.md index 0d2fecb9..52f72830 100644 --- a/Python/README.md +++ b/Python/README.md @@ -12,9 +12,10 @@ Useful links: pip install QuantLibAAD ``` -This package was called QuantLib-Risks up to version 1.33.3. `QuantLib-Risks` 1.44 is a -deprecated alias that installs `QuantLibAAD` and keeps `import QuantLib_Risks` working with a -`DeprecationWarning`. Anyone pinned to `QuantLib-Risks==1.33.3` must also pin `xad<2`. +This package was called QuantLib-Risks up to version 1.33.3. `QuantLib-Risks` 1.44.0 is the last +release under that name: a deprecated alias that installs `QuantLibAAD` 1.44 and keeps +`import QuantLib_Risks` working with a `DeprecationWarning`; newer versions are QuantLibAAD only. +Anyone pinned to `QuantLib-Risks==1.33.3` must also pin `xad<2`. Binary wheels are provided for CPython 3.10 to 3.14 on Linux (x86_64, aarch64), macOS (x86_64, arm64) and Windows (x86_64). The package requires the matching [xad](https://pypi.org/project/xad/) release, diff --git a/README.md b/README.md index f3ca1370..ec4ffa90 100644 --- a/README.md +++ b/README.md @@ -34,10 +34,11 @@ calculations as well as your own. ### Formerly QuantLib-Risks -This package was called QuantLib-Risks up to version 1.33.3. From 1.44, `QuantLib-Risks` -is a deprecated alias that installs `QuantLibAAD` and keeps `import QuantLib_Risks` working -with a `DeprecationWarning`. Please switch to `pip install QuantLibAAD` and -`import QuantLibAAD`. Anyone pinned to `QuantLib-Risks==1.33.3` must also pin `xad<2`. +This package was called QuantLib-Risks up to version 1.33.3. `QuantLib-Risks` 1.44.0 is the +last release under that name: a deprecated alias that installs `QuantLibAAD` 1.44 and keeps +`import QuantLib_Risks` working with a `DeprecationWarning`. Newer versions are published as +QuantLibAAD only, so please switch to `pip install QuantLibAAD` and `import QuantLibAAD`. +Anyone pinned to `QuantLib-Risks==1.33.3` must also pin `xad<2`. ## Notebooks diff --git a/pyproject.toml b/pyproject.toml index 3f78bf2a..a273fe77 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -94,7 +94,6 @@ install.components = ["python"] sdist.exclude = [ ".github", "binder", - "shim", "build", "lib/QuantLib/Docs", "lib/QuantLib/Examples", diff --git a/shim/QuantLib_Risks/__init__.py b/shim/QuantLib_Risks/__init__.py deleted file mode 100644 index d7554529..00000000 --- a/shim/QuantLib_Risks/__init__.py +++ /dev/null @@ -1,19 +0,0 @@ -"""Deprecated alias of QuantLibAAD.""" - -import sys -import warnings - -warnings.warn( - "QuantLib-Risks is now QuantLibAAD: pip install QuantLibAAD and import QuantLibAAD", - DeprecationWarning, - stacklevel=2, -) - -from QuantLibAAD import * -from QuantLibAAD import __version__, __hexversion__ -from QuantLibAAD import QuantLibAAD as QuantLib_Risks, _QuantLibAAD as _QuantLib_Risks - -sys.modules[__name__ + ".QuantLib_Risks"] = QuantLib_Risks -sys.modules[__name__ + "._QuantLib_Risks"] = _QuantLib_Risks - -del sys, warnings diff --git a/shim/README.md b/shim/README.md deleted file mode 100644 index 65b81578..00000000 --- a/shim/README.md +++ /dev/null @@ -1,15 +0,0 @@ -# QuantLib-Risks is now QuantLibAAD - -This package has been renamed to [QuantLibAAD](https://pypi.org/project/QuantLibAAD). -`QuantLib-Risks` 1.44 only installs `QuantLibAAD` and keeps `import QuantLib_Risks` -working, with a `DeprecationWarning`. Please switch to: - -```bash -pip install QuantLibAAD -``` - -```python -import QuantLibAAD as ql -``` - -Anyone pinned to `QuantLib-Risks==1.33.3` must also pin `xad<2`. diff --git a/shim/pyproject.toml b/shim/pyproject.toml deleted file mode 100644 index 86d9c5d2..00000000 --- a/shim/pyproject.toml +++ /dev/null @@ -1,31 +0,0 @@ -# QuantLib-Risks is now QuantLibAAD: this distribution only installs QuantLibAAD -# and keeps `import QuantLib_Risks` working, with a DeprecationWarning. - -[build-system] -requires = ["hatchling"] -build-backend = "hatchling.build" - -[project] -name = "QuantLib-Risks" -# keep in sync with ../pyproject.toml -version = "1.44.0" -description = "Deprecated: QuantLib-Risks is now QuantLibAAD" -readme = "README.md" -requires-python = ">=3.10" -license = { text = "AGPL-3.0-or-later" } -authors = [ - { name = "Auto Differentiation Dev Team", email = "dev@auto-differentiation.com" }, -] -classifiers = [ - "Development Status :: 7 - Inactive", - "License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)", - "Programming Language :: Python :: 3", -] -dependencies = ["QuantLibAAD==1.44.*"] - -[project.urls] -Homepage = "https://pypi.org/project/QuantLibAAD" -Repository = "https://github.com/auto-differentiation/QuantLibAAD-Py" - -[tool.hatch.build.targets.wheel] -packages = ["QuantLib_Risks"]