From 821796f3246b05be16ea6ebc4f5924cb0cebbbbd Mon Sep 17 00:00:00 2001 From: Aaron Zielstorff Date: Sun, 8 Nov 2026 12:43:17 +0100 Subject: [PATCH 1/2] Add REUSE-compliant copyright and license headers --- .github/workflows/build-test-docs.yml | 4 + .github/workflows/ci.yml | 4 + .github/workflows/publish-to-pypi.yml | 4 + .gitignore | 4 + AUTHORS | 3 + LICENSE | 2 +- LICENSES/CC-BY-4.0.txt | 156 ++++++++++++++++++ LICENSES/MIT.txt | 18 ++ REUSE.toml | 53 ++++++ aas_core3_2/__init__.py | 4 + aas_core3_2/common.py | 4 + aas_core3_2/constants.py | 4 + aas_core3_2/jsonization.py | 4 + aas_core3_2/jsonvalueverification.py | 4 + aas_core3_2/reporting.py | 4 + aas_core3_2/stringification.py | 4 + aas_core3_2/types.py | 4 + aas_core3_2/verification.py | 4 + aas_core3_2/xmlcommon.py | 4 + aas_core3_2/xmlization.py | 4 + aas_core3_2/xmlrpc.py | 4 + dev/continuous_integration/__init__.py | 4 + ...heck_init_and_pyproject_toml_consistent.py | 4 + dev/continuous_integration/common.py | 4 + dev/continuous_integration/mypy.ini | 4 + dev/continuous_integration/precommit.py | 22 +++ dev/continuous_integration/ruff.toml | 4 + dev/dev_scripts/__init__.py | 4 + dev/dev_scripts/codegen/meta_model.py | 4 + dev/dev_scripts/common.py | 4 + .../download_aas_core_meta_model.py | 29 +++- dev/dev_scripts/download_latest_test_data.py | 4 + dev/dev_scripts/regenerate_code.py | 45 +++++ dev/dev_scripts/rerecord_tests.py | 4 + dev/dev_scripts/update_all.py | 4 + dev/pyproject.toml | 7 +- dev/tests/__init__.py | 3 + dev/tests/common.py | 4 + dev/tests/common_jsonization.py | 4 + dev/tests/common_xmlization.py | 4 + dev/tests/test_arithmetic.py | 4 + .../test_descend_and_pass_through_visitor.py | 4 + dev/tests/test_descend_once.py | 4 + dev/tests/test_for_over_x_or_empty.py | 4 + dev/tests/test_for_x_or_default.py | 4 + dev/tests/test_json_value_verification.py | 4 + ...jsonization_of_classes_with_descendants.py | 4 + .../test_jsonization_of_concrete_classes.py | 4 + dev/tests/test_jsonization_of_enums.py | 4 + dev/tests/test_parse_int.py | 4 + dev/tests/test_string_helpers.py | 4 + dev/tests/test_verification.py | 4 + dev/tests/test_xml_rpc.py | 4 + ..._xmlization_of_classes_with_descendants.py | 4 + .../test_xmlization_of_concrete_classes.py | 4 + docs/requirements.txt | 4 + docs/source/conf.py | 4 + pyproject.toml | 4 + 58 files changed, 527 insertions(+), 3 deletions(-) create mode 100644 AUTHORS create mode 100644 LICENSES/CC-BY-4.0.txt create mode 100644 LICENSES/MIT.txt create mode 100644 REUSE.toml diff --git a/.github/workflows/build-test-docs.yml b/.github/workflows/build-test-docs.yml index 398b809..7b72b38 100644 --- a/.github/workflows/build-test-docs.yml +++ b/.github/workflows/build-test-docs.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + name: Build-test docs on: diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 0cee564..2c604d8 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + name: CI on: diff --git a/.github/workflows/publish-to-pypi.yml b/.github/workflows/publish-to-pypi.yml index 55f89cf..4e9da9c 100644 --- a/.github/workflows/publish-to-pypi.yml +++ b/.github/workflows/publish-to-pypi.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + # Based on https://github.com/actions/starter-workflows/blob/main/ci/python-publish.yml name: Publish to Pypi diff --git a/.gitignore b/.gitignore index bcb7dc3..914d8c5 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + # aas core meta model data dev_scripts/code_gen/meta_model.py diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..d451a6d --- /dev/null +++ b/AUTHORS @@ -0,0 +1,3 @@ +Marko Ristin (marko@ristin.ch, marko.ristin@gmail.com, rist@zhaw.ch) for Zurich University of Applied Sciences (ZHAW) +Tobias Langer (tobias.langer@conplement.de) for conplement AG +Aaron Zielstorff (aaron.zielstorff@iese.fraunhofer.de) for Fraunhofer Institute for Experimental Software Engineering (IESE) diff --git a/LICENSE b/LICENSE index 7b9e254..d6427c9 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2026 aas-core-works +Copyright (c) 2026 aas-core3.2-python AUTHORS Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/LICENSES/CC-BY-4.0.txt b/LICENSES/CC-BY-4.0.txt new file mode 100644 index 0000000..13ca539 --- /dev/null +++ b/LICENSES/CC-BY-4.0.txt @@ -0,0 +1,156 @@ +Creative Commons Attribution 4.0 International + + Creative Commons Corporation (“Creative Commons”) is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an “as-is” basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses. + +Considerations for licensors: Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. More considerations for licensors. + +Considerations for the public: By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor’s permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described. Although not required by our licenses, you are encouraged to respect those requests where reasonable. More considerations for the public. + +Creative Commons Attribution 4.0 International Public License + +By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions. + +Section 1 – Definitions. + + a. Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License. + + c. Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. + + d. Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements. + + e. Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material. + + f. Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License. + + g. Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license. + + h. Licensor means the individual(s) or entity(ies) granting rights under this Public License. + + i. Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them. + + j. Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world. + + k. You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning. + +Section 2 – Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to: + + A. reproduce and Share the Licensed Material, in whole or in part; and + + B. produce, reproduce, and Share Adapted Material. + + 2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions. + + 3. Term. The term of this Public License is specified in Section 6(a). + + 4. Media and formats; technical modifications allowed. The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material. + + 5. Downstream recipients. + + A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License. + + B. No downstream restrictions. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material. + + 6. No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i). + +b. Other rights. + + 1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this Public License. + + 3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties. + +Section 3 – License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified form), You must: + + A. retain the following if it is supplied by the Licensor with the Licensed Material: + + i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of warranties; + + v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable; + + B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and + + C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information. + + 3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable. + + 4. If You Share Adapted Material You produce, the Adapter's License You apply must not prevent recipients of the Adapted Material from complying with this Public License. + +Section 4 – Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database; + + b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material; and + + c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database. +For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights. + +Section 5 – Disclaimer of Warranties and Limitation of Liability. + + a. Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You. + + b. To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You. + + c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability. + +Section 6 – Term and Termination. + + a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or + + 2. upon express reinstatement by the Licensor. + + c. For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License. + + d. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License. + + e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. + +Section 7 – Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License. + +Section 8 – Interpretation. + + a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions. + + c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor. + + d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority. + +Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the “Licensor.” Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at creativecommons.org/policies, Creative Commons does not authorize the use of the trademark “Creative Commons” or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses. + +Creative Commons may be contacted at creativecommons.org. diff --git a/LICENSES/MIT.txt b/LICENSES/MIT.txt new file mode 100644 index 0000000..d817195 --- /dev/null +++ b/LICENSES/MIT.txt @@ -0,0 +1,18 @@ +MIT License + +Copyright (c) + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and +associated documentation files (the "Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the +following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial +portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT +LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO +EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE +USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/REUSE.toml b/REUSE.toml new file mode 100644 index 0000000..49184dc --- /dev/null +++ b/REUSE.toml @@ -0,0 +1,53 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + +version = 1 + +# Prose and metadata where a header would end up in the rendered output +# (e.g., README shown on PyPI, the documentation) or which can not carry +# a comment. +[[annotations]] +path = [ + "AUTHORS", + "README.rst", + "docs/**/*.rst", + "docs/**/*.md", + "aas_core3_2/py.typed", + "dev/dev_scripts/.python-version", +] +precedence = "aggregate" +SPDX-FileCopyrightText = "2026 aas-core3.2-python AUTHORS" +SPDX-License-Identifier = "MIT" + +# The snippets are inserted verbatim into the generated code by aas-core-codegen, +# so they must not carry a header of their own. +[[annotations]] +path = "dev/dev_scripts/codegen/snippets/**" +precedence = "aggregate" +SPDX-FileCopyrightText = "2026 aas-core3.2-python AUTHORS" +SPDX-License-Identifier = "MIT" + +# Test data and the recorded test outputs are generated and compared +# byte-by-byte, and JSON can not carry a comment. +[[annotations]] +path = "dev/test_data/**" +precedence = "aggregate" +SPDX-FileCopyrightText = "2026 aas-core3.2-python AUTHORS" +SPDX-License-Identifier = "MIT" + +# The meta-model and the code generated from it transcribe the AAS +# specification: the docstrings and the doc comments derived from them quote +# the definitions of the classes, attributes and constraints. That text keeps +# the license of the specification, next to the MIT license of our own code. +# The specifications published by IDTA are licensed under CC BY 4.0. +[[annotations]] +path = [ + "aas_core3_2/constants.py", + "aas_core3_2/types.py", + "aas_core3_2/verification.py", + "dev/dev_scripts/codegen/meta_model.py", +] +precedence = "aggregate" +SPDX-FileCopyrightText = "Industrial Digital Twin Association e. V." +SPDX-License-Identifier = "CC-BY-4.0" diff --git a/aas_core3_2/__init__.py b/aas_core3_2/__init__.py index 5645b74..14acea3 100644 --- a/aas_core3_2/__init__.py +++ b/aas_core3_2/__init__.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """Manipulate, verify and de/serialize Asset Administration Shells v3.2.""" # Synchronize with pyproject.toml and changelog.rst! diff --git a/aas_core3_2/common.py b/aas_core3_2/common.py index 9299bc4..fb9f777 100644 --- a/aas_core3_2/common.py +++ b/aas_core3_2/common.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """Provide common functions shared among the modules.""" # This code has been automatically generated by aas-core-codegen. diff --git a/aas_core3_2/constants.py b/aas_core3_2/constants.py index 03c96a6..bc26b1e 100644 --- a/aas_core3_2/constants.py +++ b/aas_core3_2/constants.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """Provide constant values of the meta-model.""" # This code has been automatically generated by aas-core-codegen. diff --git a/aas_core3_2/jsonization.py b/aas_core3_2/jsonization.py index 1b1cb7c..4f85f9c 100644 --- a/aas_core3_2/jsonization.py +++ b/aas_core3_2/jsonization.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """ Provide de/serialization of meta-model classes to/from JSON. diff --git a/aas_core3_2/jsonvalueverification.py b/aas_core3_2/jsonvalueverification.py index 6165d72..958b83a 100644 --- a/aas_core3_2/jsonvalueverification.py +++ b/aas_core3_2/jsonvalueverification.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """ Verify that a value is JSON-able. diff --git a/aas_core3_2/reporting.py b/aas_core3_2/reporting.py index ce085c6..5f42bd9 100644 --- a/aas_core3_2/reporting.py +++ b/aas_core3_2/reporting.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """ Report where in the data an error lies. diff --git a/aas_core3_2/stringification.py b/aas_core3_2/stringification.py index 2962944..0bf7bdb 100644 --- a/aas_core3_2/stringification.py +++ b/aas_core3_2/stringification.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """De-serialize enumerations from string representations.""" # This code has been automatically generated by aas-core-codegen. diff --git a/aas_core3_2/types.py b/aas_core3_2/types.py index f8664ac..8b185a0 100644 --- a/aas_core3_2/types.py +++ b/aas_core3_2/types.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """ --- WORK IN PROGRESS --- Provide an implementation of the Asset Administration Shell (AAS) V3.2. diff --git a/aas_core3_2/verification.py b/aas_core3_2/verification.py index 3dd8611..c5c0175 100644 --- a/aas_core3_2/verification.py +++ b/aas_core3_2/verification.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """ Verify that the instances of the meta-model satisfy the invariants. diff --git a/aas_core3_2/xmlcommon.py b/aas_core3_2/xmlcommon.py index 9a96415..e720027 100644 --- a/aas_core3_2/xmlcommon.py +++ b/aas_core3_2/xmlcommon.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """ Provide the primitives which the modules reading and writing XML share. diff --git a/aas_core3_2/xmlization.py b/aas_core3_2/xmlization.py index 420ef6e..2dfda03 100644 --- a/aas_core3_2/xmlization.py +++ b/aas_core3_2/xmlization.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """ Read and write model instances as XML. diff --git a/aas_core3_2/xmlrpc.py b/aas_core3_2/xmlrpc.py index 6e35289..131e136 100644 --- a/aas_core3_2/xmlrpc.py +++ b/aas_core3_2/xmlrpc.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """ Read and write the JSON-able values as a subset of XML-RPC. diff --git a/dev/continuous_integration/__init__.py b/dev/continuous_integration/__init__.py index 9a7781b..20bf90e 100644 --- a/dev/continuous_integration/__init__.py +++ b/dev/continuous_integration/__init__.py @@ -1 +1,5 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """Provide scripts for the continuous integration.""" diff --git a/dev/continuous_integration/check_init_and_pyproject_toml_consistent.py b/dev/continuous_integration/check_init_and_pyproject_toml_consistent.py index cf89699..ff71c59 100644 --- a/dev/continuous_integration/check_init_and_pyproject_toml_consistent.py +++ b/dev/continuous_integration/check_init_and_pyproject_toml_consistent.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """Check that meta-data in ``pyproject.toml`` and ``__init__.py`` are consistent.""" import importlib diff --git a/dev/continuous_integration/common.py b/dev/continuous_integration/common.py index 0145cf3..0244707 100644 --- a/dev/continuous_integration/common.py +++ b/dev/continuous_integration/common.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """Provide the settings shared among the continuous integration scripts.""" import os diff --git a/dev/continuous_integration/mypy.ini b/dev/continuous_integration/mypy.ini index f8b1844..da35147 100644 --- a/dev/continuous_integration/mypy.ini +++ b/dev/continuous_integration/mypy.ini @@ -1 +1,5 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + [mypy] diff --git a/dev/continuous_integration/precommit.py b/dev/continuous_integration/precommit.py index 33b141e..8c2a940 100755 --- a/dev/continuous_integration/precommit.py +++ b/dev/continuous_integration/precommit.py @@ -1,5 +1,9 @@ #!/usr/bin/env python3 +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """Run pre-commit checks on the repository.""" import argparse @@ -23,6 +27,7 @@ class Step(enum.Enum): TEST = "test" DOCTEST = "doctest" CHECK_INIT_AND_PYPROJECT_TOML_CONSISTENT = "check-init-and-pyproject-consistent" + REUSE = "reuse" def call_and_report( @@ -284,6 +289,23 @@ def main() -> int: else: print("Skipped checking that __init__.py and pyproject.toml are consistent.") + if Step.REUSE in selects and Step.REUSE not in skips: + # NOTE (aaronzi, 2026-11-08): + # reuse requires Python 3.10 or newer, so it is only installed there. + if sys.version_info < (3, 10): + print("Skipped checking the REUSE compliance (requires Python >= 3.10).") + else: + print("Checking the REUSE compliance...") + exit_code = call_and_report( + verb="check the REUSE compliance", + cmd=[sys.executable, "-m", "reuse", "lint"], + cwd=repo_root, + ) + if exit_code != 0: + return 1 + else: + print("Skipped checking the REUSE compliance.") + return 0 diff --git a/dev/continuous_integration/ruff.toml b/dev/continuous_integration/ruff.toml index d99eefb..a339825 100644 --- a/dev/continuous_integration/ruff.toml +++ b/dev/continuous_integration/ruff.toml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + target-version = "py39" [lint] diff --git a/dev/dev_scripts/__init__.py b/dev/dev_scripts/__init__.py index 6842369..979a35d 100644 --- a/dev/dev_scripts/__init__.py +++ b/dev/dev_scripts/__init__.py @@ -1 +1,5 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """Provide scripts for the development of the SDK.""" diff --git a/dev/dev_scripts/codegen/meta_model.py b/dev/dev_scripts/codegen/meta_model.py index e248f7d..2bdb4f7 100644 --- a/dev/dev_scripts/codegen/meta_model.py +++ b/dev/dev_scripts/codegen/meta_model.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2024 aas-core-meta AUTHORS +# +# SPDX-License-Identifier: MIT + # Downloaded from: https://raw.githubusercontent.com/eclipse-aascw/aas-core-meta/543f3c05b88e61a4ec3ad90ec244055b5f9b65f0/aas_core_meta/v3_2.py """ --- WORK IN PROGRESS --- diff --git a/dev/dev_scripts/common.py b/dev/dev_scripts/common.py index 2830f8b..377689d 100644 --- a/dev/dev_scripts/common.py +++ b/dev/dev_scripts/common.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """Provide the settings shared among the development scripts.""" import os diff --git a/dev/dev_scripts/download_aas_core_meta_model.py b/dev/dev_scripts/download_aas_core_meta_model.py index a76b41d..8a716b2 100644 --- a/dev/dev_scripts/download_aas_core_meta_model.py +++ b/dev/dev_scripts/download_aas_core_meta_model.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """Download the meta-model to this directory.""" import argparse @@ -13,6 +17,22 @@ REPO: Final[str] = "aas-core-meta" REF: Final[str] = "main" +# NOTE (aaronzi, 2026-11-08): +# The meta-model is copied verbatim from aas-core-meta, so we attribute it to +# its authors. We only prepend the header if the upstream file does not carry +# a license header itself, so that the header is not duplicated. +# +# REUSE-IgnoreStart +_META_MODEL_LICENSE_HEADER: Final[str] = """\ +# SPDX-FileCopyrightText: 2024 aas-core-meta AUTHORS +# +# SPDX-License-Identifier: MIT + +""" + +_LICENSE_IDENTIFIER_TAG: Final[str] = "SPDX-License-Identifier:" +# REUSE-IgnoreEnd + def _latest_commit_sha_for_path( owner: str, repo: str, ref: str, path: str, *, timeout: float = 15.0 @@ -84,7 +104,14 @@ def main() -> int: / "meta_model.py" ) - out_path.write_text(f"{banner}{content.rstrip()}\n\n{banner}", encoding="utf-8") + license_header = ( + "" if _LICENSE_IDENTIFIER_TAG in content else _META_MODEL_LICENSE_HEADER + ) + + out_path.write_text( + f"{license_header}{banner}{content.rstrip()}\n\n{banner}", + encoding="utf-8", + ) print(f"Wrote {out_path} (from commit {sha[:12]}).") return 0 diff --git a/dev/dev_scripts/download_latest_test_data.py b/dev/dev_scripts/download_latest_test_data.py index 9b13af2..aeefdf9 100644 --- a/dev/dev_scripts/download_latest_test_data.py +++ b/dev/dev_scripts/download_latest_test_data.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """Download the latest test data released on aas-core-testdatagen.""" import argparse diff --git a/dev/dev_scripts/regenerate_code.py b/dev/dev_scripts/regenerate_code.py index 64d5c54..39e47c0 100644 --- a/dev/dev_scripts/regenerate_code.py +++ b/dev/dev_scripts/regenerate_code.py @@ -1,11 +1,51 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """Generate the SDK based on the aas-core-meta model and the snippets.""" import argparse import os import pathlib +import re import subprocess import sys +import dev_scripts.common as dev_scripts_common + +# NOTE (aaronzi, 2026-11-08): +# aas-core-codegen does not emit any copyright or license information, so we +# prepend the header to the generated modules ourselves. Otherwise, the headers +# would be lost on every re-generation. +# +# REUSE-IgnoreStart +_LICENSE_HEADER = """\ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + +""" +# REUSE-IgnoreEnd + +_LEADING_SPDX_COMMENTS_RE = re.compile(r"\A(?:#\s*(?:SPDX-[A-Za-z-]+:.*)?\n|\n)*") + +_GENERATED_MARKER = "# This code has been automatically generated by aas-core-codegen." + + +def _prepend_license_header(text: str) -> str: + """Replace any leading SPDX comment block in ``text`` with our license header.""" + return _LICENSE_HEADER + _LEADING_SPDX_COMMENTS_RE.sub("", text, count=1) + + +def _add_license_headers(module_dir: pathlib.Path) -> None: + """Prepend the license header to all the modules generated by aas-core-codegen.""" + for path in sorted(module_dir.glob("*.py")): + text = path.read_text(encoding="utf-8") + if _GENERATED_MARKER not in text: + continue + + path.write_text(_prepend_license_header(text), encoding="utf-8") + def main() -> int: """Execute the main routine.""" @@ -65,6 +105,11 @@ def main() -> int: check=True, ) + # NOTE (aaronzi, 2026-11-08): + # aas-core-codegen generates both the SDK modules and the unit tests. + _add_license_headers(output_dir / dev_scripts_common.module_dir()) + _add_license_headers(output_dir / "dev" / "tests") + return 0 diff --git a/dev/dev_scripts/rerecord_tests.py b/dev/dev_scripts/rerecord_tests.py index 7d1fcff..8823076 100644 --- a/dev/dev_scripts/rerecord_tests.py +++ b/dev/dev_scripts/rerecord_tests.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """Run all tests and re-record the golden data.""" import argparse diff --git a/dev/dev_scripts/update_all.py b/dev/dev_scripts/update_all.py index 03cd622..fa01613 100644 --- a/dev/dev_scripts/update_all.py +++ b/dev/dev_scripts/update_all.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """Update to the latest meta-model and the latest test data.""" import argparse diff --git a/dev/pyproject.toml b/dev/pyproject.toml index 94e5840..c414675 100644 --- a/dev/pyproject.toml +++ b/dev/pyproject.toml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + [build-system] requires = ["setuptools>=61", "wheel"] build-backend = "setuptools.build_meta" @@ -25,7 +29,8 @@ dependencies = [ "twine", "requests==2.32.4", "types-requests==2.32.4.20250913", - "aas-core-codegen==0.0.27rc5; python_version>='3.10'" + "aas-core-codegen==0.0.27rc5; python_version>='3.10'", + "reuse==6.3.0; python_version>='3.10'" ] [tool.setuptools] diff --git a/dev/tests/__init__.py b/dev/tests/__init__.py index e69de29..1f231ce 100644 --- a/dev/tests/__init__.py +++ b/dev/tests/__init__.py @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT diff --git a/dev/tests/common.py b/dev/tests/common.py index beeccfc..9e815da 100644 --- a/dev/tests/common.py +++ b/dev/tests/common.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """Provide functionality used across the tests.""" # This code has been automatically generated by aas-core-codegen. diff --git a/dev/tests/common_jsonization.py b/dev/tests/common_jsonization.py index f44b5e7..533f8c8 100644 --- a/dev/tests/common_jsonization.py +++ b/dev/tests/common_jsonization.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """Provide common functionality for JSON de/serialization in tests.""" # This code has been automatically generated by aas-core-codegen. diff --git a/dev/tests/common_xmlization.py b/dev/tests/common_xmlization.py index 809e509..89a8f41 100644 --- a/dev/tests/common_xmlization.py +++ b/dev/tests/common_xmlization.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """Provide common functionality for XML de/serialization in tests.""" # This code has been automatically generated by aas-core-codegen. diff --git a/dev/tests/test_arithmetic.py b/dev/tests/test_arithmetic.py index 9076f7a..c86bd69 100644 --- a/dev/tests/test_arithmetic.py +++ b/dev/tests/test_arithmetic.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """ Test the arithmetic operations used in the verification. diff --git a/dev/tests/test_descend_and_pass_through_visitor.py b/dev/tests/test_descend_and_pass_through_visitor.py index 3fabada..0921b75 100644 --- a/dev/tests/test_descend_and_pass_through_visitor.py +++ b/dev/tests/test_descend_and_pass_through_visitor.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """ Test jointly :py:method:`aas_core3_2.types.Class.descend` and :py:method:`aas_core3_2.types.PassThroughVisitor`. diff --git a/dev/tests/test_descend_once.py b/dev/tests/test_descend_once.py index 6bdce17..f50c488 100644 --- a/dev/tests/test_descend_once.py +++ b/dev/tests/test_descend_once.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """Test :py:method:`aas_core3_2.types.Class.descend_once`.""" # This code has been automatically generated by aas-core-codegen. diff --git a/dev/tests/test_for_over_x_or_empty.py b/dev/tests/test_for_over_x_or_empty.py index 55025db..183380e 100644 --- a/dev/tests/test_for_over_x_or_empty.py +++ b/dev/tests/test_for_over_x_or_empty.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """Test ``over_X_or_empty`` methods.""" # This code has been automatically generated by aas-core-codegen. diff --git a/dev/tests/test_for_x_or_default.py b/dev/tests/test_for_x_or_default.py index 73c9c21..f17fda2 100644 --- a/dev/tests/test_for_x_or_default.py +++ b/dev/tests/test_for_x_or_default.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """Test ``X_or_default`` methods.""" # This code has been automatically generated by aas-core-codegen. diff --git a/dev/tests/test_json_value_verification.py b/dev/tests/test_json_value_verification.py index 7ee7a87..a1d7306 100644 --- a/dev/tests/test_json_value_verification.py +++ b/dev/tests/test_json_value_verification.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """Test :py:mod:`aas_core3_2.jsonvalueverification`.""" # This code has been automatically generated by aas-core-codegen. diff --git a/dev/tests/test_jsonization_of_classes_with_descendants.py b/dev/tests/test_jsonization_of_classes_with_descendants.py index 268d13d..53c4430 100644 --- a/dev/tests/test_jsonization_of_classes_with_descendants.py +++ b/dev/tests/test_jsonization_of_classes_with_descendants.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """Test JSON de/serialization of classes with descendants.""" # This code has been automatically generated by aas-core-codegen. diff --git a/dev/tests/test_jsonization_of_concrete_classes.py b/dev/tests/test_jsonization_of_concrete_classes.py index 40343f8..a2bc3ef 100644 --- a/dev/tests/test_jsonization_of_concrete_classes.py +++ b/dev/tests/test_jsonization_of_concrete_classes.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """Test JSON de/serialization of concrete classes.""" # This code has been automatically generated by aas-core-codegen. diff --git a/dev/tests/test_jsonization_of_enums.py b/dev/tests/test_jsonization_of_enums.py index d15e4b8..a9471ae 100644 --- a/dev/tests/test_jsonization_of_enums.py +++ b/dev/tests/test_jsonization_of_enums.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """Test JSON de/serialization of enumerations.""" # This code has been automatically generated by aas-core-codegen. diff --git a/dev/tests/test_parse_int.py b/dev/tests/test_parse_int.py index 91609ef..c28f0d5 100644 --- a/dev/tests/test_parse_int.py +++ b/dev/tests/test_parse_int.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """ Test ``int`` on strings as used in the transpiled code. diff --git a/dev/tests/test_string_helpers.py b/dev/tests/test_string_helpers.py index 5350430..bfe653e 100644 --- a/dev/tests/test_string_helpers.py +++ b/dev/tests/test_string_helpers.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """ Test the operations on strings. diff --git a/dev/tests/test_verification.py b/dev/tests/test_verification.py index 0906377..badfa8f 100644 --- a/dev/tests/test_verification.py +++ b/dev/tests/test_verification.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """Test the verification of instances.""" # This code has been automatically generated by aas-core-codegen. diff --git a/dev/tests/test_xml_rpc.py b/dev/tests/test_xml_rpc.py index 6921053..fc006d1 100644 --- a/dev/tests/test_xml_rpc.py +++ b/dev/tests/test_xml_rpc.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """Test :py:mod:`aas_core3_2.xmlrpc`.""" # This code has been automatically generated by aas-core-codegen. diff --git a/dev/tests/test_xmlization_of_classes_with_descendants.py b/dev/tests/test_xmlization_of_classes_with_descendants.py index 07b4e83..481116b 100644 --- a/dev/tests/test_xmlization_of_classes_with_descendants.py +++ b/dev/tests/test_xmlization_of_classes_with_descendants.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """Test XML de/serialization of classes with descendants.""" # This code has been automatically generated by aas-core-codegen. diff --git a/dev/tests/test_xmlization_of_concrete_classes.py b/dev/tests/test_xmlization_of_concrete_classes.py index 7f78574..1941146 100644 --- a/dev/tests/test_xmlization_of_concrete_classes.py +++ b/dev/tests/test_xmlization_of_concrete_classes.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + """Test XML de/serialization of concrete classes.""" # This code has been automatically generated by aas-core-codegen. diff --git a/docs/requirements.txt b/docs/requirements.txt index 6e8ec73..451cdf4 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + sphinx==5.3.0 sphinx-autodoc-typehints==1.19.4 sphinx-rtd-theme==1.0.0 diff --git a/docs/source/conf.py b/docs/source/conf.py index 3592721..e647a0c 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -1,5 +1,9 @@ # -*- coding: utf-8 -*- # +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT +# # Configuration file for the Sphinx documentation builder. # # This file does only contain a selection of the most common options. For a diff --git a/pyproject.toml b/pyproject.toml index ece3fc7..931424f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + [build-system] requires = ["setuptools", "setuptools-scm"] build-backend = "setuptools.build_meta" From 03c329f3f6acd016e178f1f39f95f29a9f8f2299 Mon Sep 17 00:00:00 2001 From: Aaron Zielstorff Date: Sun, 8 Nov 2026 12:48:31 +0100 Subject: [PATCH 2/2] Run the REUSE check in its own workflow The CI workflow fails on main before it reaches the reuse step of the precommit, so the separate workflow makes sure the check runs on every push and pull request. --- .github/workflows/reuse.yml | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 .github/workflows/reuse.yml diff --git a/.github/workflows/reuse.yml b/.github/workflows/reuse.yml new file mode 100644 index 0000000..1cba15b --- /dev/null +++ b/.github/workflows/reuse.yml @@ -0,0 +1,31 @@ +# SPDX-FileCopyrightText: 2026 aas-core3.2-python AUTHORS +# +# SPDX-License-Identifier: MIT + +name: Reuse + +on: + push: + branches: [ main ] + pull_request: + branches: [ main ] + +jobs: + Reuse: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: '3.12' + + - name: Install reuse + run: | + python3 -m pip install --upgrade pip + pip3 install reuse==6.3.0 + + - name: Check the REUSE compliance + run: reuse lint