diff --git a/.github/workflows/workflow.yml b/.github/workflows/workflow.yml index 264684d..2acda56 100644 --- a/.github/workflows/workflow.yml +++ b/.github/workflows/workflow.yml @@ -106,28 +106,28 @@ jobs: repository-url: https://upload.pypi.org/legacy/ user: __token__ password: ${{ secrets.PYPI_TOKEN }} - # - name: Sign the dists with Sigstore - # uses: sigstore/gh-action-sigstore-python@v2.1.1 - # with: - # inputs: >- - # ./dist/*.tar.gz - # ./dist/*.whl - # - name: Create GitHub Release - # env: - # GITHUB_TOKEN: ${{ github.token }} - # run: >- - # gh release create - # '${{ github.ref_name }}' - # --repo '${{ github.repository }}' - # --notes "" - # - name: Upload artifact signatures to GitHub Release - # env: - # GITHUB_TOKEN: ${{ github.token }} - # # Upload to GitHub Release using the `gh` CLI. - # # `dist/` contains the built packages, and the - # # sigstore-produced signatures and certificates. - # run: >- - # gh release upload - # '${{ github.ref_name }}' dist/** - # --repo '${{ github.repository }}' + - name: Sign the dists with Sigstore + uses: sigstore/gh-action-sigstore-python@v2.1.1 + with: + inputs: >- + ./dist/*.tar.gz + ./dist/*.whl + - name: Create GitHub Release + env: + GITHUB_TOKEN: ${{ github.token }} + run: >- + gh release create + '${{ github.ref_name }}' + --repo '${{ github.repository }}' + --notes "" + - name: Upload artifact signatures to GitHub Release + env: + GITHUB_TOKEN: ${{ github.token }} + # Upload to GitHub Release using the `gh` CLI. + # `dist/` contains the built packages, and the + # sigstore-produced signatures and certificates. + run: >- + gh release upload + '${{ github.ref_name }}' dist/** + --repo '${{ github.repository }}' diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..ba1778b --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,5 @@ +# Changelog + +## v0.0.1 (2024-11-18) + +- First release of `ipysensitivityprofiler` diff --git a/README.md b/README.md index a6e78d9..741f8ba 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,10 @@ # ipysensitivityprofiler + + Jupyter Widgets for visualizing local sensitivities of vectorized functions with signature `y = f(x)` where `x,y` are arrays. + --- ## Installation @@ -10,14 +13,14 @@ pip install ipysensitivityprofiler ``` --- -## Example +## Example -Example notebooks are avilable for download on [GitHub]() and hosted on [binder.org](). +Example notebooks are available for download on [GitHub](https://github.com/shb84/ipysensitivityprofiler/tree/main/notebooks) and hosted on [binder](https://mybinder.org/v2/gh/shb84/ipysensitivityprofiler.git/main?labpath=notebooks). --- ## Documentation -Documentation is available [here](TODO) (generated using [`sphinx`](https://www.sphinx-doc.org/en/master/)) +Documentation is available [here](https://shb84.github.io/ipysensitivityprofiler/) (generated using [`sphinx`](https://www.sphinx-doc.org/en/master/)) --- ## Usage diff --git a/docs/source/index.rst b/docs/source/index.rst index fde0512..538734b 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -78,6 +78,9 @@ changing) and the response surface of interest. Example Usage ------------- +.. .. image:: https://mybinder.org/badge_logo.svg +.. :target: https://mybinder.org/v2/gh/shb84/ipysensitivityprofiler.git/main?labpath=notebooks + .. collapse:: show code .. code-block:: python diff --git a/pixi.lock b/pixi.lock index e3d7131..4177833 100644 --- a/pixi.lock +++ b/pixi.lock @@ -8098,7 +8098,7 @@ packages: name: ipysensitivityprofiler version: 0.0.1 path: . - sha256: 8971949a097963650c0e98b0bc4aac095c1f16439bf6a0051f60aff568a34c3e + sha256: 36388753b6062b0347d898316cbec3ef44f979cc37959ea815e8fd1d1de5330e requires_dist: - numpy - bqplot diff --git a/pyproject.toml b/pyproject.toml index 6faf967..7afa3d8 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -197,6 +197,5 @@ build-docs = { cmd = "sphinx-build -b html docs/source build/docs/html", inputs build = { depends-on = ["build-docs", "build-dist"] } [tool.pixi.feature.release.tasks] -release-test = { cmd = "python -m twine upload build/dist/* --verbose --skip-existing --repository testpypi", inputs = ["src/**/*.py"] } -# actual release is done via GitHub actions -release = { depends-on = ["release-test"] } \ No newline at end of file +release-testpypi = { cmd = "python -m twine upload build/dist/* --verbose --skip-existing --repository testpypi", inputs = ["src/**/*.py"] } +release-pypi = { cmd = "python -m twine upload build/dist/* --verbose --skip-existing", inputs = ["src/**/*.py"] } \ No newline at end of file