Merge branch 'master' into ajax-vocabulary-fix

.flake8

@@ -1,7 +1,9 @@
 [flake8]
 # Recommend matching the black line length (default 88),
 # rather than using the flake8 default of 79:
-max-line-length = 88
+max-line-length = 100000
 extend-ignore =
     # See https://github.com/PyCQA/pycodestyle/issues/373
     E203,
+per-file-ignores =
+    src/plone/restapi/bbb.py:F401

.github/workflows/black.yml

@@ -0,0 +1,29 @@
+name: Black
+on: [push,pull_request]
+jobs:
+  build:
+    if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [3.8]
+
+    steps:
+      # git checkout
+      - uses: actions/checkout@v3
+
+      # python setup
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      # install black (with constraints)
+      - name: install black
+        run: pip install -c constraints.txt black
+
+      # run black
+      - name: run black
+        run: black src/ --check --diff

.github/workflows/flake8.yml

@@ -0,0 +1,29 @@
+name: Flake 8
+on: [push,pull_request]
+jobs:
+  build:
+    if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [3.8]
+
+    steps:
+      # git checkout
+      - uses: actions/checkout@v3
+
+      # python setup
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      # install flake8
+      - name: install flake8
+        run: pip install -c constraints.txt flake8
+
+      # run black
+      - name: run flake8
+        run: flake8 src/ setup.py

.github/workflows/pyroma.yml

@@ -0,0 +1,29 @@
+name: Pyroma
+on: [push,pull_request]
+jobs:
+  build:
+    if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [3.8]
+
+    steps:
+      # git checkout
+      - uses: actions/checkout@v3
+
+      # python setup
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      # install pyroma
+      - name: install pyroma
+        run: pip install pyroma
+
+      # run pyroma
+      - name: run pyroma
+        run: pyroma -n 10 -d .

.github/workflows/tests.yml

@@ -0,0 +1,73 @@
+name: Tests
+on: [push,pull_request]
+jobs:
+  build:
+    if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - python-version: '3.7'
+            plone-version: '5.2'
+          - python-version: '3.8'
+            plone-version: '5.2'
+          - python-version: '3.8'
+            plone-version: '6.0'
+          - python-version: '3.9'
+            plone-version: '6.0'
+          - python-version: '3.10'
+            plone-version: '6.0'
+          - python-version: '3.11'
+            plone-version: '6.0'
+
+    steps:
+      # git checkout
+      - uses: actions/checkout@v3
+
+      # python setup
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: 'pip'
+
+      # buildout eggs cache
+      - uses: actions/cache@v3
+        with:
+          path: eggs
+          key: ${{ runner.os }}-py${{ matrix.python-version }}-plone${{ matrix.plone-version }}-${{ hashFiles('*.cfg') }}
+          restore-keys: |
+            ${{ runner.os }}-py${{ matrix.python-version }}-plone${{ matrix.plone-version }}-
+            ${{ runner.os }}-py${{ matrix.python-version }}-
+
+      # python install
+      - run: pip install virtualenv
+      - run: pip install wheel
+      - name: pip install
+        run: pip install -r requirements-${{ matrix.plone-version }}.txt -r requirements-docs.txt
+
+      # buildout
+      - name: buildout
+        run: buildout -t 10 -c plone-${{ matrix.plone-version }}.x.cfg
+        env:
+          CI: true
+
+      # build sphinx
+      - name: sphinx
+        run: if [ "${{ matrix.plone-version }}" == "6.0" ] && [ ${{ matrix.python-version }} == '3.9' ]; then make docs-html; fi
+
+      # test
+      - name: test
+        run: bin/test
+
+      # test no uncommitted changes
+      - name: test no uncommitted changes
+        run: ./test-no-uncommitted-doc-changes
+        env:
+          PYTHON_VERSION: ${{ matrix.python-version }}
+          PLONE_VERSION: ${{ matrix.plone-version }}
+
+      # test for broken links
+      - name: linkcheck
+        run: if [ "${{ matrix.plone-version }}" == "6.0" ] && [ ${{ matrix.python-version }} == '3.9' ]; then make docs-linkcheckbroken; fi

.github/workflows/update_remote_docs.yml

@@ -0,0 +1,19 @@
+name: Trigger build and deploy of Plone 6 documentation
+
+on:
+  push:
+    branches:
+      - "master"
+    paths:
+      - "docs/*"
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - run: |
+          curl -X POST \
+          -H "Authorization: Bearer ${{secrets.DOCUMENTATION_BUILD_APPLICATION_KEY}}" \
+          -H "Accept: application/vnd.github.v3+json" \
+          https://api.github.com/repos/plone/documentation/actions/workflows/update_submodule.yml/dispatches \
+          -d '{"ref": "6-dev"}'

.github/workflows/zpretty.yml

@@ -0,0 +1,33 @@
+name: zpretty
+on: [push,pull_request]
+jobs:
+  build:
+    if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [3.8]
+
+    steps:
+      # git checkout
+      - uses: actions/checkout@v3
+
+      # python setup
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      # install zpretty
+      - name: install zpretty
+        run: pip install zpretty
+
+      # run zpretty
+      - name: run zpretty
+        run: find src/ -name *.zcml | xargs zpretty -i
+
+      # run git diff
+      - name: run git diff
+        run: git diff --exit-code

.gitignore

@@ -19,15 +19,19 @@ docs/.DS_Store
 /.installed.cfg
 *.pyc
 /.Python
+/bin/
 /include
 /lib
+/lib64
 /local
+/venv
 /.mr.developer.cfg
 *.mo
+docs/_build
+docs/plone.restapi.http-examples
+docs/source/README.rst
 docs/Makefile
 docs/make.bat
-docs/doctrees
-docs/html
 sphinx_build.log
 htmlcov
 npm-debug.log

.isort.cfg

@@ -5,4 +5,3 @@ force_alphabetical_sort = True
 force_single_line = True
 lines_after_imports = 2
 line_length = 200
-not_skip = __init__.py

.readthedocs.yaml

@@ -0,0 +1,29 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.9"
+    # You can also specify other tool versions:
+    # nodejs: "16"
+    # rust: "1.55"
+    # golang: "1.17"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+# formats:
+#    - pdf
+
+# Optionally declare the Python requirements required to build your docs
+python:
+  install:
+    - requirements: requirements-docs.txt