From f954569a0910168b447f7d7633b8ea1b6fe51e2a Mon Sep 17 00:00:00 2001 From: Matthew Feickert Date: Thu, 30 May 2024 14:42:26 -0500 Subject: [PATCH] chore(backport): Remove codemeta from repository * Backport PR https://github.com/scikit-hep/pyhf/pull/ 2490 * Remove all files, tests, and documentation related to codemeta, codemeta.json, and codemetapy. * codemeta is not realistically used for anything useful and codemetapy is not maintained, so there is no strong reason to keep using codemeta or to have a codemeta.json. --- .github/ISSUE_TEMPLATE/~release-checklist.md | 1 - .github/workflows/release_tests.yml | 7 - codemeta.json | 143 ------------------- docs/development.rst | 16 +-- pyproject.toml | 1 - tbump.toml | 3 - 6 files changed, 3 insertions(+), 168 deletions(-) delete mode 100644 codemeta.json diff --git a/.github/ISSUE_TEMPLATE/~release-checklist.md b/.github/ISSUE_TEMPLATE/~release-checklist.md index b2510ba3f6..d10f2fbd25 100644 --- a/.github/ISSUE_TEMPLATE/~release-checklist.md +++ b/.github/ISSUE_TEMPLATE/~release-checklist.md @@ -13,7 +13,6 @@ about: Checklist for core developers to complete as part of making a release * [ ] Verify that the release notes files correctly summarize all development changes since the last release. * [ ] Add any new use citations or published statistical models to the [Use and Citations page][citations_page]. * [ ] Verify that the citations on the [Use and Citations page][citations_page] are up to date with their current [INSPIRE](https://inspirehep.net/) record. Checking the [Dimensions listing of publication citations](https://app.dimensions.ai/discover/publication?or_subset_publication_citations=pub.1135154020) can be helpful to catch citations that are now journal publications. -* [ ] Update the ``codemeta.json`` file in the release PR if its requirements have updated. * [ ] Update the [pypa/gh-action-pypi-publish](https://github.com/pypa/gh-action-pypi-publish) GitHub Action used for deployment to TestPyPI and PyPI to the latest stable release. * [ ] Make a release to [TestPyPI][TestPyPI_pyhf] using the [workflow dispatch event trigger](https://github.com/scikit-hep/pyhf/actions/workflows/publish-package.yml). * [ ] Verify that the project README is displaying correctly on [TestPyPI][TestPyPI_pyhf]. diff --git a/.github/workflows/release_tests.yml b/.github/workflows/release_tests.yml index 89162bf60f..d31064cab4 100644 --- a/.github/workflows/release_tests.yml +++ b/.github/workflows/release_tests.yml @@ -53,10 +53,3 @@ jobs: # Though still show warnings by setting warning control to 'default'. export PYTHONWARNINGS='default' pytest tests/test_public_api.py - - # FIXME: c.f. https://github.com/proycon/codemetapy/issues/24 - - name: Verify requirements in codemeta.json - run: | - uv pip install --system jq "codemetapy>=2.3.0" - codemetapy --inputtype python --no-extras pyhf > codemeta_generated.json - diff <(jq -S .softwareRequirements codemeta.json) <(jq -S .softwareRequirements codemeta_generated.json) diff --git a/codemeta.json b/codemeta.json deleted file mode 100644 index a0a26c139a..0000000000 --- a/codemeta.json +++ /dev/null @@ -1,143 +0,0 @@ -{ - "@context": [ - "https://raw.githubusercontent.com/codemeta/codemeta/2.0/codemeta.jsonld", - "https://w3id.org/software-iodata", - "https://raw.githubusercontent.com/schemaorg/schemaorg/main/data/releases/13.0/schemaorgcontext.jsonld", - "https://w3id.org/software-types" - ], - "@id": "https://github.com/scikit-hep/pyhf", - "@type": "SoftwareSourceCode", - "applicationCategory": [ - "Scientific/Engineering", - "Scientific/Engineering > Physics" - ], - "audience": { - "@id": "/audience/science-research", - "@type": "Audience", - "audienceType": "Science/Research" - }, - "author": [ - { - "@id": "/person/lukas-heinrich", - "@type": "Person", - "email": "lukas.heinrich@cern.ch", - "familyName": "Heinrich", - "givenName": "Lukas", - "identifier": "https://orcid.org/0000-0002-4048-7584", - "position": 1 - }, - { - "@id": "/person/matthew-feickert", - "@type": "Person", - "email": "matthew.feickert@cern.ch", - "familyName": "Feickert", - "givenName": "Matthew", - "identifier": "https://orcid.org/0000-0003-4124-7862", - "position": 2 - }, - { - "@id": "/person/giordon-stark", - "@type": "Person", - "email": "gstark@cern.ch", - "familyName": "Stark", - "givenName": "Giordon", - "identifier": "https://orcid.org/0000-0001-6616-3433", - "position": 3 - } - ], - "codeRepository": "https://github.com/scikit-hep/pyhf", - "description": "pure-Python HistFactory implementation with tensors and autodiff", - "developmentStatus": "4 - Beta", - "identifier": "pyhf", - "issueTracker": "https://github.com/scikit-hep/pyhf/issues", - "keywords": "physics fitting numpy scipy tensorflow pytorch jax", - "license": "http://spdx.org/licenses/Apache-2.0", - "name": "pyhf", - "releaseNotes": "https://pyhf.readthedocs.io/en/stable/release-notes.html", - "runtimePlatform": [ - "Python 3", - "Python 3 Only", - "Python 3.10", - "Python 3.11", - "Python 3.12", - "Python 3.7", - "Python 3.8", - "Python 3.9", - "Python Implementation CPython" - ], - "softwareHelp": "https://pyhf.readthedocs.io/", - "softwareRequirements": [ - { - "@type": "SoftwareApplication", - "identifier": "click", - "name": "click", - "runtimePlatform": "Python 3", - "version": ">= 8.0.0" - }, - { - "@type": "SoftwareApplication", - "identifier": "importlib-resources", - "name": "importlib-resources", - "runtimePlatform": "Python 3", - "version": ">= 1.4.0" - }, - { - "@type": "SoftwareApplication", - "identifier": "jsonpatch", - "name": "jsonpatch", - "runtimePlatform": "Python 3", - "version": ">= 1.15" - }, - { - "@type": "SoftwareApplication", - "identifier": "jsonschema", - "name": "jsonschema", - "runtimePlatform": "Python 3", - "version": ">= 4.15.0" - }, - { - "@type": "SoftwareApplication", - "identifier": "numpy", - "name": "numpy", - "runtimePlatform": "Python 3" - }, - { - "@type": "SoftwareApplication", - "identifier": "pyyaml", - "name": "pyyaml", - "runtimePlatform": "Python 3", - "version": ">= 5.1" - }, - { - "@type": "SoftwareApplication", - "identifier": "scipy", - "name": "scipy", - "runtimePlatform": "Python 3", - "version": ">= 1.2.0" - }, - { - "@type": "SoftwareApplication", - "identifier": "tqdm", - "name": "tqdm", - "runtimePlatform": "Python 3", - "version": ">= 4.56.0" - }, - { - "@type": "SoftwareApplication", - "identifier": "typing-extensions", - "name": "typing-extensions", - "runtimePlatform": "Python 3", - "version": ">= 3.7.4.3" - } - ], - "targetProduct": { - "@id": "/commandlineapplication/pyhf", - "@type": "CommandLineApplication", - "description": "The pyhf command line interface.", - "executableName": "pyhf", - "name": "pyhf", - "runtimePlatform": "Python 3" - }, - "url": "https://github.com/scikit-hep/pyhf", - "version": "0.7.6" -} diff --git a/docs/development.rst b/docs/development.rst index fa6149a8a9..3d3341cd12 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -267,19 +267,9 @@ sdist and wheel, and then deploy them to PyPI_. Context Files and Archive Metadata ---------------------------------- -The ``.zenodo.json`` and ``codemeta.json`` files have the version number -automatically updated through ``tbump``, though their additional metadata -should be checked periodically by the dev team (probably every release). -The ``codemeta.json`` file can be generated automatically **from a PyPI install** -of ``pyhf`` using ``codemetapy`` - -.. code-block:: console - - codemetapy --no-extras pyhf > codemeta.json - -though the ``author`` metadata will still need to be checked and revised by hand. -The ``.zenodo.json`` is currently generated by hand, so it is worth using -``codemeta.json`` as a guide to edit it. +The ``.zenodo.json`` file has the version number automatically updated through +``tbump``, though its additional metadata should be checked periodically by +the dev team (probably every release). .. _bump version GitHub Actions workflow: https://github.com/scikit-hep/pyhf/actions/workflows/bump-version.yml .. _PyPI: https://pypi.org/project/pyhf/ diff --git a/pyproject.toml b/pyproject.toml index ea44c41a5c..74e8a0150c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -135,7 +135,6 @@ develop = [ "tbump>=6.7.0", "pre-commit", "nox", - "codemetapy>=2.3.0", ] [tool.hatch.version] diff --git a/tbump.toml b/tbump.toml index edc6fa00e6..935bbeba09 100644 --- a/tbump.toml +++ b/tbump.toml @@ -48,9 +48,6 @@ src = "src/pyhf/data/citation.bib" [[file]] src = ".zenodo.json" -[[file]] -src = "codemeta.json" - [[file]] src = "CITATION.cff"