Upgrade ccf python package to pyproject.toml (#6376)

.azure-pipelines-gh-pages.yml

@@ -56,9 +56,9 @@ jobs:
           set -ex
           python3.8 -m venv env
           source env/bin/activate
-          pip install wheel
-          pip install -U -r doc/requirements.txt
+          pip install -U pip
           pip install -U -e ./python
+          pip install -U -r doc/requirements.txt
           pip install -U -r doc/historical_ccf_requirements.txt
           sphinx-multiversion -D smv_remote_whitelist=origin doc build/html
         displayName: Sphinx Multi-version
@@ -73,9 +73,9 @@ jobs:
           set -ex
           python3.8 -m venv env
           source env/bin/activate
-          pip install wheel
-          pip install -U -r doc/requirements.txt
+          pip install -U pip
           pip install -U -e ./python
+          pip install -U -r doc/requirements.txt
           sphinx-build doc build/html
         displayName: Sphinx Single-version
         condition: |

.prettierignore

@@ -23,7 +23,6 @@ latex/
 env/
 *.egg-info
 **/dist
-python/setup.py
 .mypy_cache
 3rdparty/
 *.html

CMakeLists.txt

@@ -566,9 +566,6 @@ set(CMAKE_GENERATED_COMMENT
 configure_file(
   ${CCF_DIR}/src/common/version.h.in ${CCF_DIR}/include/ccf/version.h @ONLY
 )
-configure_file(
-  ${CCF_DIR}/python/version.py.in ${CCF_DIR}/python/version.py @ONLY
-)
 install(FILES ${CCF_DIR}/include/ccf/version.h DESTINATION include/ccf)
 
 file(READ ${CCF_DIR}/doc/host_config_schema/cchost_config.json
@@ -1143,7 +1140,7 @@ if(BUILD_TESTS)
       # Unsafe builds do not follow normal version conventions
       add_test(NAME versionifier_test
                COMMAND ${PYTHON}
-                       ${CMAKE_SOURCE_DIR}/python/ccf/_versionifier.py
+                       ${CMAKE_SOURCE_DIR}/python/src/ccf/_versionifier.py
       )
 
       add_test(NAME github_version_lts_test

python/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

python/MANIFEST.in

@@ -1,6 +0,0 @@
-include requirements.txt
-include ccf/py.typed
-
-include utils/submit_recovery_share.sh
-include utils/keygenerator.sh
-include utils/verify_quote.sh

python/pyproject.toml

@@ -0,0 +1,51 @@
+[build-system]
+requires = ["setuptools>=71.0", "setuptools_scm>=8"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ccf"
+# Automatically extract version number from git environment
+# See https://github.com/pypa/setuptools_scm for details
+dynamic = ["version"]
+authors = [
+  { name="CCF Team", email="CCF-Sec@microsoft.com" },
+]
+description = "Set of tools and utilities for the Confidential Consortium Framework (CCF)"
+readme = "README.md"
+requires-python = ">=3.8"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: Apache Software License",
+]
+dependencies = [
+    "loguru >= 0.5, == 0.*",
+    "cryptography == 42.*",
+    "string-color >= 1.2.1, == 1.*",
+    "pycose >= 1.0.1, == 1.*",
+    "setuptools == 71.*",
+    "packaging == 24.*"
+]
+
+[tool.setuptools]
+script-files = [
+    "utils/keygenerator.sh",
+    "utils/submit_recovery_share.sh",
+    "utils/verify_quote.sh"
+]
+
+[tool.setuptools_scm]
+version_file = "src/ccf/version.py"
+root = ".."
+
+[project.urls]
+Homepage = "https://github.com/microsoft/ccf"
+Issues = "https://github.com/microsoft/ccf/issues"
+
+[project.scripts]
+ccf_cose_sign1 = "ccf.cose:sign_cli"
+ccf_cose_sign1_prepare = "ccf.cose:prepare_cli"
+ccf_cose_sign1_finish = "ccf.cose:finish_cli"
+"read_ledger.py" = "ccf.read_ledger:main"
+"ledger_viz.py" = "ccf.ledger_viz:main"
+"ledger_code.py" = "ccf.ledger_code:main"
+"split_ledger.py" = "ccf.split_ledger:main"

python/requirements.txt

@@ -1,6 +0,0 @@
-loguru >= 0.5, == 0.*
-cryptography == 42.*
-string-color >= 1.2.1, == 1.*
-pycose >= 1.0.1, == 1.*
-setuptools == 58.*
-packaging == 24.*

python/setup.py

@@ -1,57 +0,0 @@
-# Copyright (c) Microsoft Corporation. All rights reserved.
-# Licensed under the Apache 2.0 License.
-
-from os import path
-from setuptools import setup  # type: ignore
-
-import version  # type: ignore
-
-import ccf._versionifier
-
-PACKAGE_NAME = "ccf"
-UTILITIES_PATH = "utils"
-TEMPLATES_PATH = path.join(PACKAGE_NAME, "templates")
-
-path_here = path.abspath(path.dirname(__file__))
-
-with open(path.join(path_here, "README.md"), encoding="utf-8") as f:
-    long_description = f.read()
-
-with open("requirements.txt", encoding="utf-8") as f:
-    requirements = f.read().splitlines()
-
-setup(
-    name=PACKAGE_NAME,
-    version=str(ccf._versionifier.to_python_version(version.CCF_VERSION)),
-    description="Set of tools and utilities for the Confidential Consortium Framework (CCF)",
-    long_description=long_description,
-    long_description_content_type="text/markdown",
-    url="https://github.com/microsoft/CCF/tree/main/python",
-    license="Apache License 2.0",
-    author="CCF Team",
-    classifiers=[
-        "Development Status :: 3 - Alpha",
-        "Intended Audience :: Developers",
-        "Programming Language :: Python :: 3",
-    ],
-    packages=[PACKAGE_NAME],
-    python_requires=">=3.8",
-    install_requires=requirements,
-    scripts=[
-        path.join(UTILITIES_PATH, "keygenerator.sh"),
-        path.join(UTILITIES_PATH, "submit_recovery_share.sh"),
-        path.join(UTILITIES_PATH, "verify_quote.sh"),
-    ],
-    entry_points={
-        "console_scripts": [
-            "ccf_cose_sign1 = ccf.cose:sign_cli",
-            "ccf_cose_sign1_prepare = ccf.cose:prepare_cli",
-            "ccf_cose_sign1_finish = ccf.cose:finish_cli",
-            "read_ledger.py = ccf.read_ledger:main",
-            "ledger_viz.py = ccf.ledger_viz:main",
-            "ledger_code.py = ccf.ledger_code:main",
-            "split_ledger.py = ccf.split_ledger:main",
-        ]
-    },
-    include_package_data=True,
-)

python/version.py.in

@@ -1,12 +0,0 @@
-# Copyright (c) Microsoft Corporation. All rights reserved.
-# Licensed under the Apache 2.0 License.
-
-# fmt: off
-
-#
-#   @CMAKE_GENERATED_COMMENT@
-#
-
-CCF_VERSION = "@CCF_VERSION@"
-
-# fmt: on

scripts/ci-checks.sh

@@ -118,7 +118,7 @@ endgroup
 group "Python lint dependencies"
 # Install test dependencies before linting
 pip install -U -r tests/requirements.txt 1>/dev/null
-pip install -U -r python/requirements.txt 1>/dev/null
+pip install -U -e python 1>/dev/null
 endgroup
 
 group "Python lint"

tests/test_install.sh

@@ -54,7 +54,8 @@ fi
 python3.8 -m venv env
 # shellcheck source=/dev/null
 source env/bin/activate
-python -m pip install -e ../../../python
+python -m pip install -U pip
+python -m pip install -U -e ../../../python
 
 # Poll until service has died
 while [ "$(service_http_status)" == "200" ]; do