Skip to content

Commit

Permalink
Configuring with plone/meta
Browse files Browse the repository at this point in the history
  • Loading branch information
gforcada committed Apr 1, 2023
1 parent 0decdb0 commit 674728e
Show file tree
Hide file tree
Showing 7 changed files with 203 additions and 14 deletions.
39 changes: 39 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Generated from:
# https://github.com/plone/meta/tree/master/config/default
#
# 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


[*] # 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}]
# 2 space indentation
indent_size = 2

[{Makefile,.gitmodules}]
# Tab indentation (no size specified, but view as 4 spaces)
indent_style = tab
indent_size = unset
tab_width = unset
5 changes: 5 additions & 0 deletions .meta.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Generated from:
# https://github.com/plone/meta/tree/master/config/default
[meta]
template = "default"
commit-id = "47959565"
42 changes: 42 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Generated from:
# https://github.com/plone/meta/tree/master/config/default
ci:
autofix_prs: false
autoupdate_schedule: monthly

repos:
- repo: https://github.com/asottile/pyupgrade
rev: v3.3.1
hooks:
- id: pyupgrade
args: [--py38-plus]
- repo: https://github.com/pycqa/isort
rev: 5.12.0
hooks:
- id: isort
- repo: https://github.com/psf/black
rev: 23.1.0
hooks:
- id: black
- repo: https://github.com/collective/zpretty
rev: 3.0.2
hooks:
- id: zpretty
- repo: https://github.com/PyCQA/flake8
rev: 6.0.0
hooks:
- id: flake8
- repo: https://github.com/codespell-project/codespell
rev: v2.2.2
hooks:
- id: codespell
additional_dependencies:
- tomli
- 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
2 changes: 2 additions & 0 deletions news/47959565.internal
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Update configuration files.
[plone devs]
42 changes: 42 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Generated from:
# https://github.com/plone/meta/tree/master/config/default
[tool.towncrier]
filename = "CHANGES.rst"
directory = "news/"
Expand All @@ -18,3 +20,43 @@ showcontent = true
directory = "bugfix"
name = "Bug fixes:"
showcontent = true

[[tool.towncrier.type]]
directory = "internal"
name = "Internal:"
showcontent = true

[[tool.towncrier.type]]
directory = "documentation"
name = "Documentation:"
showcontent = true

[[tool.towncrier.type]]
directory = "tests"
name = "Tests"
showcontent = true

[tool.isort]
profile = "plone"

[tool.black]
target-version = ["py38"]

[tool.dependencychecker]
Zope = [
# Zope own provided namespaces
'App', 'OFS', 'Products.Five', 'Products.OFSP', 'Products.PageTemplates',
'Products.SiteAccess', 'Shared', 'Testing', 'ZPublisher', 'ZTUtils',
'Zope2', 'webdav', 'zmi',
# Zope dependencies
'Acquisition', 'DateTime', 'transaction', 'zExceptions', 'ZODB', 'zope.component',
'zope.configuration', 'zope.container', 'zope.deferredimport', 'zope.event',
'zope.exceptions', 'zope.globalrequest', 'zope.i18n', 'zope.i18nmessageid',
'zope.interface', 'zope.lifecycleevent', 'zope.location', 'zope.publisher',
'zope.schema', 'zope.security', 'zope.site', 'zope.traversing', 'AccessControl',
]
'plone.base' = [
'AccessControl', 'Products.BTreeFolder2', 'Products.CMFCore',
'Products.CMFDynamicViewFTI', 'zope.deprecation',
]
python-dateutil = ['dateutil']
34 changes: 20 additions & 14 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -1,17 +1,23 @@
[build_sphinx]
source-dir = docs/source
build-dir = docs
all_files = 1

[upload_sphinx]
upload-dir = docs/html

# Generated from:
# https://github.com/plone/meta/tree/master/config/default
[bdist_wheel]
universal = 0

[isort]
# black compatible Plone isort rules:
profile = black
force_alphabetical_sort = True
force_single_line = True
lines_after_imports = 2
[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,

[check-manifest]
ignore =
.editorconfig
.meta.toml
.pre-commit-config.yaml
tox.ini
53 changes: 53 additions & 0 deletions tox.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Generated from:
# https://github.com/plone/meta/tree/master/config/default
[tox]
# We need 4.4.0 for constrain_package_deps.
min_version = 4.4.0
envlist =
format
lint
test

[testenv]
allowlist_externals =
sh

[testenv:format]
description = automatically reformat code
skip_install = true
deps =
pre-commit
commands =
pre-commit run -a pyupgrade
pre-commit run -a isort
pre-commit run -a black
pre-commit run -a zpretty

[testenv:lint]
description = run linters that will help improve the code style
skip_install = true
deps =
pre-commit
commands =
pre-commit run -a

[testenv:dependencies]
description = check if the package defines all its dependencies and generate a graph out of them
deps =
z3c.dependencychecker==2.11
pipdeptree==2.5.1
graphviz # optional dependency of pipdeptree
commands =
dependencychecker
sh -c 'pipdeptree --exclude setuptools,wheel,pipdeptree,z3c.dependencychecker,zope.interface,zope.component --graph-output svg > dependencies.svg'

[testenv:test]
usedevelop = true
constrain_package_deps = true
deps =
zope.testrunner
-c https://dist.plone.org/release/6.0-dev/constraints.txt
commands =
zope-testrunner --test-path={toxinidir} -s plone.app.discussion
extras =
test

0 comments on commit 674728e

Please sign in to comment.