integration-python-library/pyproject.toml at main · unfoldedcircle/integration-python-library · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
[build-system]
requires = ["setuptools", "setuptools-scm"]
build-backend = "setuptools.build_meta"

[project]
name = "ucapi"
authors = [
    {name = "Unfolded Circle ApS", email = "hello@unfoldedcircle.com"}
]
license = {text = "MPL-2.0"}
description = "Python wrapper for the Unfolded Circle Integration API"
classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Intended Audience :: Developers",
    "License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)",
    "Operating System :: OS Independent",
    "Topic :: Software Development :: Libraries",
    "Topic :: Home Automation",
    "Programming Language :: Python :: 3.11",
]
requires-python = ">=3.11"
dependencies = [
    "protobuf~=6.33.2",
    "pyee>=9.0",
    "websockets>=14.0",
    "zeroconf>=0.120.0",
]
dynamic = ["version"]

[project.readme]
file = "README.md"
content-type = "text/markdown; charset=UTF-8"

[project.urls]
"Homepage"    = "https://www.unfoldedcircle.com/"
"Source Code" = "https://github.com/unfoldedcircle/integration-python-library"
"Bug Reports" = "https://github.com/unfoldedcircle/integration-python-library/issues"
"Discord"     = "http://unfolded.chat/"
"Forum"       = "https://unfolded.community/"

[project.optional-dependencies]
testing = [
    "pylint==4.0.4",
    "flake8-docstrings",
    "flake8",
    "black",
    "isort",
]

[tool.setuptools]
packages = ["ucapi", "ucapi.proto"]
platforms = ["any"]
license-files = ["LICENSE"]

[tool.setuptools_scm]
write_to = "ucapi/_version.py"

[tool.isort]
profile = "black"
skip_glob = ["ucapi/proto/*_pb2.py", "ucapi/proto/*_pb2.pyi"]

[tool.pylint.exceptions]
overgeneral-exceptions = ["builtins.BaseException", "builtins.Exception"]

[tool.pylint.format]
max-line-length = "88"

[tool.pylint.main]
ignore-paths = [
    # ignore generated file
    "ucapi/_version.py",
    # ignore generated protobuf modules (Python + type stubs and optional gRPC stubs)
    "ucapi/proto/.*_pb2.py",
    "ucapi/proto/.*_pb2.pyi",
]

[tool.pylint."messages control"]
# Reasons disabled:
# duplicate-code - unavoidable
# global-statement - not yet considered
# too-many-* - are not enforced for the sake of readability
# too-few-* - same as too-many-*
# line-too-long - handled with black & flake8
# fixme - refactoring in progress

disable = [
    "duplicate-code",
    "global-statement",
    "too-many-arguments",
    "too-many-instance-attributes",
    "too-few-public-methods",
    "line-too-long",
    "fixme"
]

[tool.pylint.STRING]
# This flag controls whether inconsistent-quotes generates a warning when the
# character used as a quote delimiter is used inconsistently within a module.
check-quote-consistency = true


[tool.black]
line-length = 88
# Exclude generated protobuf modules, even if passed explicitly to Black
force-exclude = """
(
  proto/.+_pb2(?:_grpc)?\\.pyi?$  # *_pb2.py, *_pb2.pyi, *_pb2_grpc.py
)
"""