libi2c-python/pyproject.toml at master · feeph/libi2c-python · 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
110
111
112
113
114
115
116
117
118
119
# =========================================================================
# project
# =========================================================================

# quickstart:
#   install uv as documented on
#   https://docs.astral.sh/uv/getting-started/installation/

# dependencies
#   - use `uv add <package>` and `uv remove <package>` to manage dependencies
#   - use `uv add -d -G dev <packag>` to add a dev dependency
#   - use `uv sync --upgrade` to update dependencies

# usage:
#   - use `uv run <pythonfile>` to execute code
#   - use `uv run pytest` to perform unit tests

# line lengths:
#   - Excessive line lengths aren't good. But rather then automatically
#     breaking them and turning into vertical blocks we want to see the
#     nastiness sticking out prominently.

[project]
name = "feeph.i2c"
version = "0.7.4"
description = "abstraction layer for the I²C bus (incl. simulation for testing)"
authors = [
    {name = "Feeph Aifeimei", email = "55798703+feeph@users.noreply.github.com"},
]
requires-python = ">=3.10,<3.13"
dependencies = [
    "adafruit-blinka~=8.46",
    "gpiod~=2.2",
    "RPI-GPIO~=0.7",
]
readme = "README.md"
license = {text = "GPL-3.0-or-later"}
keywords = [
    "i2c",
    "smbus",
]
classifiers = [
    "Development Status :: 3 - Alpha",
    "Intended Audience :: Developers",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Topic :: System :: Hardware",
    "Typing :: Typed",
]

# https://docs.astral.sh/uv/concepts/build-backend/#using-the-uv-build-backend
[build-system]
requires = ["uv_build>=0.11.7,<0.12"]
build-backend = "uv_build"

[dependency-groups]
dev = [
    "autopep8      ~= 2.3",
    "copier        ~= 9.14",
    "coverage-lcov ~= 0.3",
    "flake8        ~= 7.3",
    "mypy          ~= 1.20",
    "pylint        ~= 3.3",
    "pytest-cov    ~= 5.0",
    "pytest-sugar  ~= 1.1",
    "types-PyYAML  ~= 6.0",
]

[project.urls]
Homepage = "https://github.com/feeph/libi2c-python"
Issues = "https://github.com/feeph/libi2c-python/issues"

# =========================================================================
# tooling
# =========================================================================

# -------------------------------------------------------------------------
# autopep8
# -------------------------------------------------------------------------

# https://pypi.org/project/autopep8/
[tool.autopep8]
max_line_length = 250
ignore          = ["E221", "E241"]
in-place = true

# -------------------------------------------------------------------------
# isort
#  - https://github.com/PyCQA/isort
#  - https://pycqa.github.io/isort/docs/configuration/config_files
# -------------------------------------------------------------------------

[tool.isort]
# use the black profile but override "multi_line_output"
profile           = "black"
line_length       = 250
multi_line_output = 7
src_paths         = ["feeph/", "tests/"]

# -------------------------------------------------------------------------
# pylint
#  - https://docs.pylint.org/run.html
#  - https://docs.pylint.org/features.html
# -------------------------------------------------------------------------

[tool.pylint."MESSAGES CONTROL"]
fail-under = 8
max-line-length = 250
disable = "no-else-return,use-list-literal,useless-else-on-loop"

# -------------------------------------------------------------------------
# uv
#  - https://docs.astral.sh/uv/configuration/files/
# -------------------------------------------------------------------------

[tool.uv.build-backend]
module-name = "feeph.i2c"
module-root = ""