From b1d2ffa0f92837bef2aaf0cc7dd54d77a092864d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maximilian=20H=C3=B6rstrup?= Date: Mon, 6 May 2024 09:36:25 +0200 Subject: [PATCH] Add missing license information (#52) - Add missing license information - Add REUSE compliance check workflow - Add REUSE compliance batch in README.md --- .github/workflows/build_and_deploy_docu.yml | 3 + .github/workflows/code_coverage.yml | 3 + .github/workflows/lint.yml | 3 + .github/workflows/reuse.yaml | 17 +++ .github/workflows/tests.yml | 3 + .gitignore | 115 +------------------ .reuse/dep5 | 4 +- LICENSES/CC0-1.0.txt | 121 ++++++++++++++++++++ README.md | 1 + mkdocs.yml | 3 + requirements.txt | 3 + 11 files changed, 163 insertions(+), 113 deletions(-) create mode 100644 .github/workflows/reuse.yaml create mode 100644 LICENSES/CC0-1.0.txt diff --git a/.github/workflows/build_and_deploy_docu.yml b/.github/workflows/build_and_deploy_docu.yml index e28996c..61f6f8a 100644 --- a/.github/workflows/build_and_deploy_docu.yml +++ b/.github/workflows/build_and_deploy_docu.yml @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: The PFDL Contributors +# SPDX-License-Identifier: CC0-1.0 + name: Build and deploy docu on: diff --git a/.github/workflows/code_coverage.yml b/.github/workflows/code_coverage.yml index 3b5224c..5e4067a 100644 --- a/.github/workflows/code_coverage.yml +++ b/.github/workflows/code_coverage.yml @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: The PFDL Contributors +# SPDX-License-Identifier: CC0-1.0 + name: Measure code coverage on: diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 4a086b9..00b0031 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: The PFDL Contributors +# SPDX-License-Identifier: CC0-1.0 + name: Lint on: diff --git a/.github/workflows/reuse.yaml b/.github/workflows/reuse.yaml new file mode 100644 index 0000000..76fe570 --- /dev/null +++ b/.github/workflows/reuse.yaml @@ -0,0 +1,17 @@ +# SPDX-FileCopyrightText: The PFDL Contributors +# SPDX-License-Identifier: CC0-1.0 + +name: REUSE Compliance Check + +on: [push, pull_request] + +permissions: + contents: read + +jobs: + reuse: + runs-on: ubuntu-22.04 + steps: + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + - name: REUSE Compliance Check + uses: fsfe/reuse-action@a46482ca367aef4454a87620aa37c2be4b2f8106 # v3.0.0 \ No newline at end of file diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 8dab097..9629efc 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: The PFDL Contributors +# SPDX-License-Identifier: CC0-1.0 + name: Tests on: diff --git a/.gitignore b/.gitignore index 40fc62e..3b2df06 100644 --- a/.gitignore +++ b/.gitignore @@ -1,12 +1,7 @@ -# Byte-compiled / optimized / DLL files -__pycache__/ -*.py[cod] -*$py.class - -# C extensions -*.so +# SPDX-FileCopyrightText: The PFDL Contributors +# SPDX-License-Identifier: CC0-1.0 -# Distribution / packaging +__pycache__/ .Python build/ develop-eggs/ @@ -26,121 +21,19 @@ share/python-wheels/ *.egg MANIFEST -# PyInstaller -# Usually these files are written by a python script from a template -# before PyInstaller builds the exe, so as to inject date/other infos into it. *.manifest *.spec -# Installer logs -pip-log.txt -pip-delete-this-directory.txt - -# Unit test / coverage reports htmlcov/ -.tox/ -.nox/ .coverage .coverage.* .cache -nosetests.xml coverage.xml -*.cover -*.py,cover -.hypothesis/ -.pytest_cache/ -cover/ - -# Translations -*.mo -*.pot - -# Django stuff: -*.log -local_settings.py -db.sqlite3 -db.sqlite3-journal - -# Flask stuff: -instance/ -.webassets-cache - -# Scrapy stuff: -.scrapy - -# Sphinx documentation -docs/_build/ - -# PyBuilder -.pybuilder/ -target/ - -# Jupyter Notebook -.ipynb_checkpoints - -# IPython -profile_default/ -ipython_config.py - -# pyenv -# For a library or package, you might want to ignore these files since the code is -# intended to run in multiple environments; otherwise, check them in: -# .python-version - -# pipenv -# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. -# However, in case of collaboration, if having platform-specific dependencies or dependencies -# having no cross-platform support, pipenv may install dependencies that don't work, or not -# install all needed dependencies. -#Pipfile.lock - -# PEP 582; used by e.g. github.com/David-OConnor/pyflow -__pypackages__/ - -# Celery stuff -celerybeat-schedule -celerybeat.pid - -# SageMath parsed files -*.sage.py - -# Environments -.env -.venv -env/ -venv/ -ENV/ -env.bak/ -venv.bak/ - -# Spyder project settings -.spyderproject -.spyproject - -# Rope project settings -.ropeproject - -# mkdocs documentation -/site - -# mypy -.mypy_cache/ -.dmypy.json -dmypy.json - -# Pyre type checker -.pyre/ - -# pytype static type analyzer -.pytype/ - -# Cython debug symbols -cython_debug/ *.interp *.tokens *.vscode *.antlr -# for debugging only +# ignore log files temp/ \ No newline at end of file diff --git a/.reuse/dep5 b/.reuse/dep5 index 960ba3f..49ff511 100644 --- a/.reuse/dep5 +++ b/.reuse/dep5 @@ -1,7 +1,7 @@ Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ Upstream-Name: pfdl Upstream-Contact: -Source: https://github.com/iml130/pfd +Source: https://github.com/iml130/pfdl Files: docs/img/* Copyright: The PFDL Contributors @@ -9,4 +9,4 @@ License: CC-BY-4.0 Files: pfdl_grammar/* Copyright: The PFDL Contributors -License: MIT +License: MIT \ No newline at end of file diff --git a/LICENSES/CC0-1.0.txt b/LICENSES/CC0-1.0.txt new file mode 100644 index 0000000..1625c17 --- /dev/null +++ b/LICENSES/CC0-1.0.txt @@ -0,0 +1,121 @@ +Creative Commons Legal Code + +CC0 1.0 Universal + + CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE + LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN + ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS + INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES + REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS + PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM + THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED + HEREUNDER. + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator +and subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for +the purpose of contributing to a commons of creative, cultural and +scientific works ("Commons") that the public can reliably and without fear +of later claims of infringement build upon, modify, incorporate in other +works, reuse and redistribute as freely as possible in any form whatsoever +and for any purposes, including without limitation commercial purposes. +These owners may contribute to the Commons to promote the ideal of a free +culture and the further production of creative, cultural and scientific +works, or to gain reputation or greater distribution for their Work in +part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any +expectation of additional consideration or compensation, the person +associating CC0 with a Work (the "Affirmer"), to the extent that he or she +is an owner of Copyright and Related Rights in the Work, voluntarily +elects to apply CC0 to the Work and publicly distribute the Work under its +terms, with knowledge of his or her Copyright and Related Rights in the +Work and the meaning and intended legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not +limited to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, + communicate, and translate a Work; + ii. moral rights retained by the original author(s) and/or performer(s); +iii. publicity and privacy rights pertaining to a person's image or + likeness depicted in a Work; + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + v. rights protecting the extraction, dissemination, use and reuse of data + in a Work; + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation + thereof, including any amended or successor version of such + directive); and +vii. other similar, equivalent or corresponding rights throughout the + world based on applicable law or treaty, and any national + implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention +of, applicable law, Affirmer hereby overtly, fully, permanently, +irrevocably and unconditionally waives, abandons, and surrenders all of +Affirmer's Copyright and Related Rights and associated claims and causes +of action, whether now known or unknown (including existing as well as +future claims and causes of action), in the Work (i) in all territories +worldwide, (ii) for the maximum duration provided by applicable law or +treaty (including future time extensions), (iii) in any current or future +medium and for any number of copies, and (iv) for any purpose whatsoever, +including without limitation commercial, advertising or promotional +purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each +member of the public at large and to the detriment of Affirmer's heirs and +successors, fully intending that such Waiver shall not be subject to +revocation, rescission, cancellation, termination, or any other legal or +equitable action to disrupt the quiet enjoyment of the Work by the public +as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason +be judged legally invalid or ineffective under applicable law, then the +Waiver shall be preserved to the maximum extent permitted taking into +account Affirmer's express Statement of Purpose. In addition, to the +extent the Waiver is so judged Affirmer hereby grants to each affected +person a royalty-free, non transferable, non sublicensable, non exclusive, +irrevocable and unconditional license to exercise Affirmer's Copyright and +Related Rights in the Work (i) in all territories worldwide, (ii) for the +maximum duration provided by applicable law or treaty (including future +time extensions), (iii) in any current or future medium and for any number +of copies, and (iv) for any purpose whatsoever, including without +limitation commercial, advertising or promotional purposes (the +"License"). The License shall be deemed effective as of the date CC0 was +applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, such +partial invalidity or ineffectiveness shall not invalidate the remainder +of the License, and in such case Affirmer hereby affirms that he or she +will not (i) exercise any of his or her remaining Copyright and Related +Rights in the Work or (ii) assert any associated claims and causes of +action with respect to the Work, in either case contrary to Affirmer's +express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + b. Affirmer offers the Work as-is and makes no representations or + warranties of any kind concerning the Work, express, implied, + statutory or otherwise, including without limitation warranties of + title, merchantability, fitness for a particular purpose, non + infringement, or the absence of latent or other defects, accuracy, or + the present or absence of errors, whether or not discoverable, all to + the greatest extent permissible under applicable law. + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without + limitation any person's Copyright and Related Rights in the Work. + Further, Affirmer disclaims responsibility for obtaining any necessary + consents, permissions or other rights required for any use of the + Work. + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to + this CC0 or use of the Work. \ No newline at end of file diff --git a/README.md b/README.md index c7cb499..979cc5e 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,7 @@ Production Flow Description Language ![Lint Check](https://github.com/iml130/pfdl/actions/workflows/lint.yml/badge.svg?branch=main) ![Code Coverage](https://github.com/iml130/pfdl/actions/workflows/code_coverage.yml/badge.svg?branch=main) ![Build and deploy Docu](https://github.com/iml130/pfdl/actions/workflows/build_and_deploy_docu.yml/badge.svg?branch=main) +[![REUSE status](https://api.reuse.software/badge/github.com/iml130/pfdl)](https://api.reuse.software/info/github.com/iml130/pfdl) **DISCLAIMER**: This project is not intended for everyday use and made available without any support. diff --git a/mkdocs.yml b/mkdocs.yml index 9491605..c5c67a7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: The PFDL Contributors +# SPDX-License-Identifier: CC0-1.0 + site_name: Production Flow Description Language site_url: https://example.com/ diff --git a/requirements.txt b/requirements.txt index 7e59222..f20c8cd 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: The PFDL Contributors +# SPDX-License-Identifier: CC0-1.0 + antlr4-python3-runtime==4.9.3 antlr-denter snakes