Merge pull request #134 from reinout/config-with-default-template-5d3…

…e918e

Trying out plone/meta

.editorconfig

@@ -0,0 +1,56 @@
+# Generated from:
+# https://github.com/plone/meta/tree/main/config/default
+# See the inline comments on how to expand/tweak this configuration file
+#
+# EditorConfig Configuration file, for more details see:
+# http://EditorConfig.org
+# EditorConfig is a convention description, that could be interpreted
+# by multiple editors to enforce common coding conventions for specific
+# file types
+
+# top-most EditorConfig file:
+# Will ignore other EditorConfig files in Home directory or upper tree level.
+root = true
+
+
+[*]
+# Default settings for all files.
+# Unix-style newlines with a newline ending every file
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+# Set default charset
+charset = utf-8
+# Indent style default
+indent_style = space
+# Max Line Length - a hard line wrap, should be disabled
+max_line_length = off
+
+[*.{py,cfg,ini}]
+# 4 space indentation
+indent_size = 4
+
+[*.{yml,zpt,pt,dtml,zcml,html,xml}]
+# 2 space indentation
+indent_size = 2
+
+[*.{json,jsonl,js,jsx,ts,tsx,css,less,scss}]
+# Frontend development
+# 2 space indentation
+indent_size = 2
+max_line_length = 80
+
+[{Makefile,.gitmodules}]
+# Tab indentation (no size specified, but view as 4 spaces)
+indent_style = tab
+indent_size = unset
+tab_width = unset
+
+
+##
+# Add extra configuration options in .meta.toml:
+#  [editorconfig]
+#  extra_lines = """
+#  _your own configuration lines_
+#  """
+##

.flake8

@@ -0,0 +1,22 @@
+# Generated from:
+# https://github.com/plone/meta/tree/main/config/default
+# See the inline comments on how to expand/tweak this configuration file
+[flake8]
+doctests = 1
+ignore =
+    # black takes care of line length
+    E501,
+    # black takes care of where to break lines
+    W503,
+    # black takes care of spaces within slicing (list[:])
+    E203,
+    # black takes care of spaces after commas
+    E231,
+
+##
+# Add extra configuration options in .meta.toml:
+#  [flake8]
+#  extra_lines = """
+#  _your own configuration lines_
+#  """
+##

.github/workflows/meta.yml

@@ -0,0 +1,68 @@
+# Generated from:
+# https://github.com/plone/meta/tree/main/config/default
+# See the inline comments on how to expand/tweak this configuration file
+name: Meta
+on:
+  push:
+    branches:
+      - master
+      - main
+  pull_request:
+    branches:
+      - master
+      - main
+  workflow_dispatch:
+
+##
+# To set environment variables for all jobs, add in .meta.toml:
+# [github]
+# env = """
+#     debug: 1
+#     image-name: 'org/image'
+#     image-tag: 'latest'
+# """
+##
+
+jobs:
+  qa:
+    uses: plone/meta/.github/workflows/qa.yml@main
+  test:
+    uses: plone/meta/.github/workflows/test.yml@main
+  coverage:
+    uses: plone/meta/.github/workflows/coverage.yml@main
+  dependencies:
+    uses: plone/meta/.github/workflows/dependencies.yml@main
+  release_ready:
+    uses: plone/meta/.github/workflows/release_ready.yml@main
+  circular:
+    uses: plone/meta/.github/workflows/circular.yml@main
+
+##
+# To modify the list of default jobs being created add in .meta.toml:
+# [github]
+# jobs = [
+#    "qa",
+#    "test",
+#    "coverage",
+#    "dependencies",
+#    "release_ready",
+#    "circular",
+#    ]
+##
+
+##
+# To request that some OS level dependencies get installed
+# when running tests/coverage jobs, add in .meta.toml:
+# [github]
+# os_dependencies = "git libxml2 libxslt"
+##
+
+
+##
+# Specify additional jobs in .meta.toml:
+#  [github]
+#  extra_lines = """
+#  another:
+#    uses: org/repo/.github/workflows/file.yml@main
+#  """
+##

.github/workflows/testing.yml

@@ -30,25 +30,7 @@ jobs:
         run: pip --version
       - name: Install dependencies
         run: python -m pip install -r requirements.txt
-      # formatters
-      - name: Run pyupgrade
-        if: matrix.python-version == '3.11'
-        run: pyupgrade --py38-plus setup.py `find z3c -name "*.py"`
-      - name: Run isort
-        if: matrix.python-version == '3.11'
-        run: isort --check-only setup.py z3c/
-      - name: Run black
-        if: matrix.python-version == '3.11'
-        run: black --check setup.py z3c/
-      # linters
-      - name: Lint with codespell
-        if: matrix.python-version == '3.11'
-        run: codespell *.rst setup.py z3c/
-      - name: Lint with flake8
-        if: matrix.python-version == '3.11'
-        run: flake8 setup.py z3c/ --count --show-source --statistics
-      # tests and coverage
       - name: Test
-        run: pytest
+        run: coverage run --source=z3c/dependencychecker -m pytest
       - name: Coverage
         run: coveralls --service=github

.gitignore

@@ -1,17 +1,56 @@
-*.py[co]
-*.egg
+# Generated from:
+# https://github.com/plone/meta/tree/main/config/default
+# See the inline comments on how to expand/tweak this configuration file
+# python related
 *.egg-info
-dist
-build
-eggs
-parts
-bin
-lib
-pyvenv.cfg
-var
-sdist
-develop-eggs
-.installed.cfg
-pip-log.txt
+*.pyc
+*.pyo
+
+# translation related
+*.mo
+
+# tools related
+build/
 .coverage
+.*project
+coverage.xml
+dist/
+docs/_build
+__pycache__/
 .tox
+.vscode/
+node_modules/
+
+# venv / buildout related
+bin/
+develop-eggs/
+eggs/
+.eggs/
+etc/
+.installed.cfg
+include/
+lib/
+lib64
+.mr.developer.cfg
+parts/
+pyvenv.cfg
+var/
+local.cfg
+
+# mxdev
+/instance/
+/.make-sentinels/
+/*-mxdev.txt
+/reports/
+/sources/
+/venv/
+.installed.txt
+
+
+##
+# Add extra configuration options in .meta.toml:
+#  [gitignore]
+#  extra_lines = """
+#  _your own configuration lines_
+#  """
+##

.meta.toml

@@ -0,0 +1,23 @@
+# Generated from:
+# https://github.com/plone/meta/tree/main/config/default
+# See the inline comments on how to expand/tweak this configuration file
+[meta]
+template = "default"
+commit-id = "bf23101c"
+
+[tox]
+test_runner = "pytest"
+use_pytest_plone = false
+
+[pyproject]
+dependencies_ignores = "['stdlib_list',]"
+check_manifest_extra_lines = """
+ignore-bad-ideas = [
+    "z3c/dependencychecker/tests/sample1/src/sample1.egg-info_in/PKG-INFO",
+    ]
+"""
+extra_lines = """
+[tool.zestreleaser]
+create-wheel = true
+extra-message = "[ci skip]"
+"""

.pre-commit-config.yaml

@@ -0,0 +1,94 @@
+# Generated from:
+# https://github.com/plone/meta/tree/main/config/default
+# See the inline comments on how to expand/tweak this configuration file
+ci:
+    autofix_prs: false
+    autoupdate_schedule: monthly
+
+repos:
+-   repo: https://github.com/asottile/pyupgrade
+    rev: v3.15.0
+    hooks:
+    -   id: pyupgrade
+        args: [--py38-plus]
+-   repo: https://github.com/pycqa/isort
+    rev: 5.13.2
+    hooks:
+    -   id: isort
+-   repo: https://github.com/psf/black
+    rev: 24.1.1
+    hooks:
+    -   id: black
+-   repo: https://github.com/collective/zpretty
+    rev: 3.1.0
+    hooks:
+    -   id: zpretty
+
+##
+# Add extra configuration options in .meta.toml:
+#  [pre_commit]
+#  zpretty_extra_lines = """
+#  _your own configuration lines_
+#  """
+##
+-   repo: https://github.com/PyCQA/flake8
+    rev: 7.0.0
+    hooks:
+    -   id: flake8
+
+##
+# Add extra configuration options in .meta.toml:
+#  [pre_commit]
+#  flake8_extra_lines = """
+#  _your own configuration lines_
+#  """
+##
+-   repo: https://github.com/codespell-project/codespell
+    rev: v2.2.6
+    hooks:
+    -   id: codespell
+        additional_dependencies:
+          - tomli
+
+##
+# Add extra configuration options in .meta.toml:
+#  [pre_commit]
+#  codespell_extra_lines = """
+#  _your own configuration lines_
+#  """
+##
+-   repo: https://github.com/mgedmin/check-manifest
+    rev: "0.49"
+    hooks:
+    -   id: check-manifest
+-   repo: https://github.com/regebro/pyroma
+    rev: "4.2"
+    hooks:
+    -   id: pyroma
+-   repo: https://github.com/mgedmin/check-python-versions
+    rev: "0.22.0"
+    hooks:
+    -   id: check-python-versions
+        args: ['--only', 'setup.py,pyproject.toml']
+-   repo: https://github.com/collective/i18ndude
+    rev: "6.1.0"
+    hooks:
+    -   id: i18ndude
+
+
+##
+# Add extra configuration options in .meta.toml:
+#  [pre_commit]
+#  i18ndude_extra_lines = """
+#  _your own configuration lines_
+#  """
+##
+
+
+##
+# Add extra configuration options in .meta.toml:
+#  [pre_commit]
+#  extra_lines = """
+#  _your own configuration lines_
+#  """
+##