From 7585d23396bc68c6a379d957c649e958e7200e75 Mon Sep 17 00:00:00 2001 From: aquint-zama Date: Thu, 9 Dec 2021 11:26:15 +0100 Subject: [PATCH] chore: fix license / licence naming --- Makefile | 24 +-- licences/licences_mac_dev.txt | 152 ------------------ .../licenses_linux_dev.txt | 2 +- .../licenses_linux_user.txt | 0 .../licenses_mac_user.txt | 0 .../make_utils/{licences.sh => licenses.sh} | 30 ++-- 6 files changed, 28 insertions(+), 180 deletions(-) delete mode 100644 licences/licences_mac_dev.txt rename licences/licences_linux_dev.txt => licenses/licenses_linux_dev.txt (99%) rename licences/licences_linux_user.txt => licenses/licenses_linux_user.txt (100%) rename licences/licences_mac_user.txt => licenses/licenses_mac_user.txt (100%) rename script/make_utils/{licences.sh => licenses.sh} (79%) diff --git a/Makefile b/Makefile index 1a1aa3469..636f88ff2 100644 --- a/Makefile +++ b/Makefile @@ -85,7 +85,7 @@ flake8: python_linting: pylint flake8 .PHONY: conformance # Run command to fix some conformance issues automatically -conformance: finalize_nb python_format supported_functions licences +conformance: finalize_nb python_format supported_functions licenses .PHONY: pcc # Run pre-commit checks pcc: @@ -93,7 +93,7 @@ pcc: --no-print-directory pcc_internal PCC_DEPS := check_python_format check_finalize_nb python_linting mypy_ci pydocstyle shell_lint -PCC_DEPS += check_version_coherence check_supported_functions check_benchmarks check_licences +PCC_DEPS += check_version_coherence check_supported_functions check_benchmarks check_licenses # Not commented on purpose for make help, since internal .PHONY: pcc_internal @@ -317,23 +317,23 @@ supported_functions: check_supported_functions: poetry run python script/doc_utils/gen_supported_ufuncs.py docs/user/howto/NUMPY_SUPPORT.md --check -.PHONY: licences # Generate the list of licenses of dependencies -licences: - @./script/make_utils/licences.sh +.PHONY: licenses # Generate the list of licenses of dependencies +licenses: + @./script/make_utils/licenses.sh -.PHONY: check_licences # Check if the licenses of dependencies have changed -check_licences: +.PHONY: check_licenses # Check if the licenses of dependencies have changed +check_licenses: @TMP_OUT="$$(mktemp)" && \ - if ! poetry run env bash ./script/make_utils/licences.sh --check > "$${TMP_OUT}"; then \ + if ! poetry run env bash ./script/make_utils/licenses.sh --check > "$${TMP_OUT}"; then \ cat "$${TMP_OUT}"; \ rm -f "$${TMP_OUT}"; \ - echo "Error while checking licences, see log above."; \ - echo "Consider re-running 'make licences'"; \ + echo "Error while checking licenses, see log above."; \ + echo "Consider re-running 'make licenses'"; \ exit 1; \ else \ - echo "Licences check OK"; \ + echo "Licenses check OK"; \ fi -.PHONY: check_licences +.PHONY: check_licenses .PHONY: help # Generate list of targets with descriptions help: diff --git a/licences/licences_mac_dev.txt b/licences/licences_mac_dev.txt deleted file mode 100644 index 603ea3e75..000000000 --- a/licences/licences_mac_dev.txt +++ /dev/null @@ -1,152 +0,0 @@ - Name Version License - Babel 2.9.1 BSD License - GitPython 3.1.24 BSD License - Jinja2 3.0.3 BSD License - MarkupSafe 2.0.1 BSD License - Pillow 8.4.0 Historical Permission Notice and Disclaimer (HPND) - PyYAML 6.0 MIT License - Pygments 2.10.0 BSD License - QtPy 1.11.3 MIT License - Send2Trash 1.8.0 BSD License - Sphinx 4.3.0 BSD License - alabaster 0.7.12 BSD License - appnope 0.1.2 BSD License - argon2-cffi 21.1.0 MIT License - astroid 2.8.6 GNU Lesser General Public License v2 (LGPLv2) - attrs 21.2.0 MIT License - backcall 0.2.0 BSD License - beautifulsoup4 4.10.0 MIT License - black 21.12b0 MIT License - bleach 4.1.0 Apache Software License - certifi 2021.10.8 Mozilla Public License 2.0 (MPL 2.0) - cffi 1.15.0 MIT License - charset-normalizer 2.0.9 MIT License - click 8.0.3 BSD License - click-log 0.3.2 MIT License - colorama 0.4.4 BSD License - coverage 6.2 Apache Software License - cycler 0.11.0 BSD License - debugpy 1.5.1 Eclipse Public License 2.0 (EPL-2.0); MIT License - decorator 5.1.0 BSD License - defusedxml 0.7.1 Python Software Foundation License - docutils 0.17.1 BSD License; GNU General Public License (GPL); Public Domain; Python Software Foundation License - dotty-dict 1.3.0 MIT License - entrypoints 0.3 MIT License - execnet 1.9.0 MIT License - flake8 3.9.2 MIT License - flake8-bugbear 21.11.29 MIT License - fonttools 4.28.3 MIT License - gitdb 4.0.9 BSD License - idna 3.3 BSD License - imagesize 1.3.0 MIT License - importlib-metadata 4.8.2 Apache Software License - iniconfig 1.1.1 MIT License - invoke 1.6.0 BSD License - ipykernel 6.6.0 BSD License - ipython 7.30.1 BSD License - ipython-genutils 0.2.0 BSD License - ipywidgets 7.6.5 BSD License - isort 5.10.1 MIT License - jedi 0.18.1 MIT License - jsonschema 4.2.1 MIT License - jupyter 1.0.0 BSD License - jupyter-client 7.1.0 BSD License - jupyter-console 6.4.0 BSD License - jupyter-core 4.9.1 BSD License - jupyterlab-pygments 0.1.2 BSD - jupyterlab-widgets 1.0.2 BSD License - keyring 23.4.0 MIT License; Python Software Foundation License - kiwisolver 1.3.2 BSD License - lazy-object-proxy 1.6.0 BSD License - loguru 0.5.3 MIT License - markdown-it-py 1.1.0 MIT License - matplotlib 3.5.0 Python Software Foundation License - matplotlib-inline 0.1.3 BSD 3-Clause - mccabe 0.6.1 MIT License - mdit-py-plugins 0.2.8 MIT License - mistune 0.8.4 BSD License - mypy 0.910 MIT License - mypy-extensions 0.4.3 MIT License - myst-parser 0.15.2 MIT License - nbclient 0.5.9 BSD License - nbconvert 6.3.0 BSD License - nbformat 5.1.3 BSD License - nbmake 0.9 Apache Software License - nbsphinx 0.8.7 MIT License - nest-asyncio 1.5.4 BSD License - networkx 2.6.3 BSD License - notebook 6.4.6 BSD License - numpy 1.21.4 BSD License - packaging 21.3 Apache Software License; BSD License - pandocfilters 1.5.0 BSD License - parso 0.8.3 MIT License - pathspec 0.9.0 Mozilla Public License 2.0 (MPL 2.0) - pexpect 4.8.0 ISC License (ISCL) - pickleshare 0.7.5 MIT License - pkginfo 1.8.2 MIT License - platformdirs 2.4.0 MIT License - pluggy 1.0.0 MIT License - prometheus-client 0.12.0 Apache Software License - prompt-toolkit 3.0.23 BSD License - psutil 5.8.0 BSD License - ptyprocess 0.7.0 ISC License (ISCL) - py 1.11.0 MIT License - py-cpuinfo 8.0.0 MIT License - pycodestyle 2.7.0 MIT License - pycparser 2.21 BSD License - pydantic 1.8.2 MIT License - pydocstyle 6.1.1 MIT License - pyflakes 2.3.1 MIT License - pygments-style-tomorrow 1.0.0.1 UNKNOWN - pygraphviz 1.7 BSD License - pylint 2.11.1 GNU General Public License v2 (GPLv2) - pyparsing 3.0.6 MIT License - pyrsistent 0.18.0 MIT License - pytest 6.2.5 MIT License - pytest-cov 3.0.0 MIT License - pytest-forked 1.3.0 MIT License - pytest-randomly 3.10.3 MIT License - pytest-xdist 2.4.0 MIT License - python-dateutil 2.8.2 Apache Software License; BSD License - python-dotenv 0.19.2 BSD License - python-gitlab 2.10.1 GNU Lesser General Public License v3 (LGPLv3) - python-semantic-release 7.19.2 MIT - pytz 2021.3 MIT License - pyzmq 22.3.0 BSD License; GNU Library or Lesser General Public License (LGPL) - qtconsole 5.2.1 BSD License - readme-renderer 30.0 Apache Software License - requests 2.26.0 Apache Software License - requests-toolbelt 0.9.1 Apache Software License - rfc3986 1.5.0 Apache Software License - semver 2.13.0 BSD License - setuptools-scm 6.3.2 MIT License - six 1.16.0 MIT License - smmap 5.0.0 BSD License - snowballstemmer 2.2.0 BSD License - soupsieve 2.3.1 MIT License - sphinx-copybutton 0.4.0 MIT License - sphinx-zama-theme 2.0.5 BSD License - sphinxcontrib-applehelp 1.0.2 BSD License - sphinxcontrib-devhelp 1.0.2 BSD License - sphinxcontrib-htmlhelp 2.0.0 BSD License - sphinxcontrib-jsmath 1.0.1 BSD License - sphinxcontrib-qthelp 1.0.3 BSD License - sphinxcontrib-serializinghtml 1.1.5 BSD License - terminado 0.12.1 BSD License - testpath 0.5.0 BSD License - toml 0.10.2 MIT License - tomli 1.2.2 MIT License - tomlkit 0.7.0 MIT License - torch 1.10.0 BSD License - torchvision 0.11.1 BSD - tornado 6.1 Apache Software License - tqdm 4.62.3 MIT License; Mozilla Public License 2.0 (MPL 2.0) - traitlets 5.1.1 BSD License - twine 3.7.1 Apache Software License - typing-extensions 4.0.1 Python Software Foundation License - urllib3 1.26.7 MIT License - wcwidth 0.2.5 MIT License - webencodings 0.5.1 BSD License - widgetsnbextension 3.5.2 BSD License - wrapt 1.13.3 BSD License - zipp 3.6.0 MIT License diff --git a/licences/licences_linux_dev.txt b/licenses/licenses_linux_dev.txt similarity index 99% rename from licences/licences_linux_dev.txt rename to licenses/licenses_linux_dev.txt index 81d2f0985..168e0b240 100644 --- a/licences/licences_linux_dev.txt +++ b/licenses/licenses_linux_dev.txt @@ -128,7 +128,7 @@ snowballstemmer 2.2.0 BSD License soupsieve 2.3.1 MIT License sphinx-copybutton 0.4.0 MIT License - sphinx-zama-theme 2.0.5 BSD License + sphinx-zama-theme 2.0.6 BSD License sphinxcontrib-applehelp 1.0.2 BSD License sphinxcontrib-devhelp 1.0.2 BSD License sphinxcontrib-htmlhelp 2.0.0 BSD License diff --git a/licences/licences_linux_user.txt b/licenses/licenses_linux_user.txt similarity index 100% rename from licences/licences_linux_user.txt rename to licenses/licenses_linux_user.txt diff --git a/licences/licences_mac_user.txt b/licenses/licenses_mac_user.txt similarity index 100% rename from licences/licences_mac_user.txt rename to licenses/licenses_mac_user.txt diff --git a/script/make_utils/licences.sh b/script/make_utils/licenses.sh similarity index 79% rename from script/make_utils/licences.sh rename to script/make_utils/licenses.sh index a98733df5..8584fe323 100755 --- a/script/make_utils/licences.sh +++ b/script/make_utils/licenses.sh @@ -2,14 +2,14 @@ set -e -BASENAME="licences" -LICENCE_DIRECTORY="licences" +BASENAME="licenses" +LICENSE_DIRECTORY="licenses" CHECK=0 DIFF_TOOL="diff --ignore-all-space --ignore-tab-expansion --ignore-space-change --ignore-all-space --ignore-blank-lines --strip-trailing-cr" TMP_VENV_PATH="/tmp/tmp_venv" -DO_USER_LICENCES=1 -DO_DEV_LICENCES=1 -OUTPUT_DIRECTORY="${LICENCE_DIRECTORY}" +DO_USER_LICENSES=1 +DO_DEV_LICENSES=1 +OUTPUT_DIRECTORY="${LICENSE_DIRECTORY}" while [ -n "$1" ] do @@ -39,13 +39,13 @@ else exit 255 fi -if [ $DO_USER_LICENCES -eq 1 ] +if [ $DO_USER_LICENSES -eq 1 ] then - # Licences for user (install in a temporary venv) - echo "Doing licences for user" + #Licenses for user (install in a temporary venv) + echo "Doing licenses for user" FILENAME="${BASENAME}_${OS}_user.txt" - LICENSES_FILENAME="${LICENCE_DIRECTORY}/${FILENAME}" + LICENSES_FILENAME="${LICENSE_DIRECTORY}/${FILENAME}" NEW_LICENSES_FILENAME="${OUTPUT_DIRECTORY}/${FILENAME}" rm -rf $TMP_VENV_PATH/tmp_venv @@ -70,13 +70,13 @@ then fi fi -if [ $DO_DEV_LICENCES -eq 1 ] +if [ $DO_DEV_LICENSES -eq 1 ] then - # Licences for developer (install in a temporary venv) - echo "Doing licences for developper" + # Licenses for developer (install in a temporary venv) + echo "Doing licenses for developper" FILENAME="${BASENAME}_${OS}_dev.txt" - LICENSES_FILENAME="${LICENCE_DIRECTORY}/${FILENAME}" + LICENSES_FILENAME="${LICENSE_DIRECTORY}/${FILENAME}" NEW_LICENSES_FILENAME="${OUTPUT_DIRECTORY}/${FILENAME}" rm -rf $TMP_VENV_PATH/tmp_venv @@ -99,7 +99,7 @@ then fi fi -rm -f ${LICENCE_DIRECTORY}/licences_*.txt.tmp +rm -f ${LICENSE_DIRECTORY}/licenses_*.txt.tmp rm -rf $TMP_VENV_PATH/tmp_venv -echo "End of licence script" +echo "End of license script"