diff --git a/.azure-pipelines-gh-pages.yml b/.azure-pipelines-gh-pages.yml index 742c347bc18a..87ba1165f3a0 100644 --- a/.azure-pipelines-gh-pages.yml +++ b/.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: | diff --git a/.azure-pipelines-templates/install_others.yml b/.azure-pipelines-templates/install_others.yml index d67bcf54f574..bc6a540f7376 100644 --- a/.azure-pipelines-templates/install_others.yml +++ b/.azure-pipelines-templates/install_others.yml @@ -3,9 +3,8 @@ steps: set -ex python3.8 -m venv env source ./env/bin/activate - pip install -r requirements.txt - pip install wheel - python setup.py bdist_wheel + pip install wheel build + python -m build --wheel WHL=`ls dist/*.whl` cp $WHL $(Build.ArtifactStagingDirectory) WHL=`basename $WHL` diff --git a/.github/workflows/pypi.yml b/.github/workflows/pypi.yml index 55a30723502b..a515403ec5bb 100644 --- a/.github/workflows/pypi.yml +++ b/.github/workflows/pypi.yml @@ -29,6 +29,5 @@ jobs: cd python python3 -m venv env source ./env/bin/activate - pip install -r requirements.txt pip install twine twine upload -u __token__ -p ${{ secrets.PYPI_TOKEN }} *.whl diff --git a/.gitignore b/.gitignore index 73afe1010b64..3657cff40c53 100644 --- a/.gitignore +++ b/.gitignore @@ -45,3 +45,5 @@ tests/perf-system/analyzer/*.png **/*.ipynb* scripts/azure_deployment/.env tests/external_executor/executors/ccf/protobuf/*.proto +.env +python/src/ccf/version.py diff --git a/.prettierignore b/.prettierignore index 436b962631e2..7ede896b56f4 100644 --- a/.prettierignore +++ b/.prettierignore @@ -23,7 +23,6 @@ latex/ env/ *.egg-info **/dist -python/setup.py .mypy_cache 3rdparty/ *.html diff --git a/CMakeLists.txt b/CMakeLists.txt index d53a19ebf2a6..b19c6ef3b5c4 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -576,9 +576,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 @@ -1117,7 +1114,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 diff --git a/python/LICENSE b/python/LICENSE new file mode 100644 index 000000000000..d64569567334 --- /dev/null +++ b/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. diff --git a/python/MANIFEST.in b/python/MANIFEST.in deleted file mode 100644 index 98e2c2b2f7ff..000000000000 --- a/python/MANIFEST.in +++ /dev/null @@ -1,7 +0,0 @@ -include requirements.txt -include ccf/py.typed - -include utils/scurl.sh -include utils/submit_recovery_share.sh -include utils/keygenerator.sh -include utils/verify_quote.sh diff --git a/python/pyproject.toml b/python/pyproject.toml new file mode 100644 index 000000000000..c1df378fcccd --- /dev/null +++ b/python/pyproject.toml @@ -0,0 +1,52 @@ +[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 = ".." +git_describe_command = "git describe --dirty --tags --long --match ccf-*" + +[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" diff --git a/python/requirements.txt b/python/requirements.txt deleted file mode 100644 index f1522d39f9d4..000000000000 --- a/python/requirements.txt +++ /dev/null @@ -1,4 +0,0 @@ -loguru >= 0.5, == 0.* -cryptography == 42.* -string-color >= 1.2.1, == 1.* -pycose >= 1.0.1, == 1.* \ No newline at end of file diff --git a/python/setup.py b/python/setup.py deleted file mode 100644 index 9b32aa8c0157..000000000000 --- a/python/setup.py +++ /dev/null @@ -1,60 +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 - -# pylint: disable=import-error -import version # type: ignore - -# pylint: disable=protected-access -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, "scurl.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, -) diff --git a/python/ccf/__init__.py b/python/src/ccf/__init__.py similarity index 100% rename from python/ccf/__init__.py rename to python/src/ccf/__init__.py diff --git a/python/ccf/_versionifier.py b/python/src/ccf/_versionifier.py similarity index 96% rename from python/ccf/_versionifier.py rename to python/src/ccf/_versionifier.py index 2d7aba487b1f..7f19870e4035 100644 --- a/python/ccf/_versionifier.py +++ b/python/src/ccf/_versionifier.py @@ -1,8 +1,7 @@ # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the Apache 2.0 License. -# pylint: disable=import-error, no-name-in-module -from setuptools.extern.packaging.version import ( # type: ignore +from packaging.version import ( # type: ignore Version, InvalidVersion, ) diff --git a/python/ccf/cose.py b/python/src/ccf/cose.py similarity index 100% rename from python/ccf/cose.py rename to python/src/ccf/cose.py diff --git a/python/ccf/ledger.py b/python/src/ccf/ledger.py similarity index 100% rename from python/ccf/ledger.py rename to python/src/ccf/ledger.py diff --git a/python/ccf/ledger_code.py b/python/src/ccf/ledger_code.py similarity index 100% rename from python/ccf/ledger_code.py rename to python/src/ccf/ledger_code.py diff --git a/python/ccf/ledger_viz.py b/python/src/ccf/ledger_viz.py similarity index 100% rename from python/ccf/ledger_viz.py rename to python/src/ccf/ledger_viz.py diff --git a/python/ccf/merkletree.py b/python/src/ccf/merkletree.py similarity index 100% rename from python/ccf/merkletree.py rename to python/src/ccf/merkletree.py diff --git a/python/ccf/py.typed b/python/src/ccf/py.typed similarity index 100% rename from python/ccf/py.typed rename to python/src/ccf/py.typed diff --git a/python/ccf/read_ledger.py b/python/src/ccf/read_ledger.py similarity index 100% rename from python/ccf/read_ledger.py rename to python/src/ccf/read_ledger.py diff --git a/python/ccf/receipt.py b/python/src/ccf/receipt.py similarity index 100% rename from python/ccf/receipt.py rename to python/src/ccf/receipt.py diff --git a/python/ccf/split_ledger.py b/python/src/ccf/split_ledger.py similarity index 100% rename from python/ccf/split_ledger.py rename to python/src/ccf/split_ledger.py diff --git a/python/ccf/tx_id.py b/python/src/ccf/tx_id.py similarity index 100% rename from python/ccf/tx_id.py rename to python/src/ccf/tx_id.py diff --git a/python/version.py.in b/python/version.py.in deleted file mode 100644 index 496e8adc239e..000000000000 --- a/python/version.py.in +++ /dev/null @@ -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 \ No newline at end of file diff --git a/scripts/ci-checks.sh b/scripts/ci-checks.sh index f4ac00c6e446..f31aa6da7289 100755 --- a/scripts/ci-checks.sh +++ b/scripts/ci-checks.sh @@ -115,7 +115,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" diff --git a/tests/infra/github.py b/tests/infra/github.py index de3a575dc06c..f1bbc07e3ca6 100644 --- a/tests/infra/github.py +++ b/tests/infra/github.py @@ -11,8 +11,7 @@ import requests import cimetrics.env -# pylint: disable=import-error, no-name-in-module -from setuptools.extern.packaging.version import Version # type: ignore +from packaging.version import Version # type: ignore from loguru import logger as LOG diff --git a/tests/infra/node.py b/tests/infra/node.py index 0f11b2ce31ca..049bf771755d 100644 --- a/tests/infra/node.py +++ b/tests/infra/node.py @@ -25,8 +25,7 @@ # pylint: disable=protected-access import ccf._versionifier -# pylint: disable=import-error, no-name-in-module -from setuptools.extern.packaging.version import Version # type: ignore +from packaging.version import Version # type: ignore from loguru import logger as LOG diff --git a/tests/infra/remote.py b/tests/infra/remote.py index 2420e6b36b2e..f81d02c80e54 100644 --- a/tests/infra/remote.py +++ b/tests/infra/remote.py @@ -16,7 +16,7 @@ import json import infra.snp as snp import ccf._versionifier -from setuptools.extern.packaging.version import ( # type: ignore +from packaging.version import ( # type: ignore Version, ) diff --git a/tests/test_install.sh b/tests/test_install.sh index 62fa82005562..a49474cbf1d8 100755 --- a/tests/test_install.sh +++ b/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