hopsworks-apigen/pyproject.toml at main · logicalclocks/hopsworks-apigen · 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
120
[project]
name = "hopsworks-apigen"
version = "1.0.5"
requires-python = ">=3.9"

[project.optional-dependencies]
build = ["griffe"]

[dependency-groups]
dev = ["ruff", "pyright", "setuptools", "mkdocs"]

[project.entry-points."setuptools.finalize_distribution_options"]
finalize_distribution_options_aliases = "hopsworks_apigen.setuptools:finalize_distribution_options"

[project.entry-points."distutils.commands"]
build_aliases = "hopsworks_apigen.setuptools:build_aliases"
install_aliases = "hopsworks_apigen.setuptools:install_aliases"
[project.entry-points."mkdocs.plugins"]
hopsworks-apigen = "hopsworks_apigen.mkdocs:HopsworksApigenMkDocs"

[build-system]
requires = ["setuptools"]
build-backend = "setuptools.build_meta"

[tool.ruff]
# Exclude a variety of commonly ignored directories.
exclude = [
    ".bzr",
    ".direnv",
    ".eggs",
    ".git",
    ".git-rewrite",
    ".hg",
    ".ipynb_checkpoints",
    ".mypy_cache",
    ".nox",
    ".pants.d",
    ".pyenv",
    ".pytest_cache",
    ".pytype",
    ".ruff_cache",
    ".svn",
    ".tox",
    ".venv",
    ".vscode",
    "__pypackages__",
    "_build",
    "buck-out",
    "build",
    "dist",
    "node_modules",
    "site-packages",
    "venv",
    "java",
    "transformation_test_helper.py", # File excluded from ruff formatting to maintain formatting required for tests
]

# Same as Black.
line-length = 88
indent-width = 4

# Assume Python 3.9+ syntax.
target-version = "py39"

[tool.ruff.lint]
select = [
    "E",
    "F",
    "B",
    "C4",
    "ISC",
    "PIE",
    "PYI",
    "Q",
    "RSE",
    "RET",
    "SIM",
    "TC",
    "I",
    "W",
    "D2",
    "D3",
    "D4",
    "INP",
    "UP",
    "FA",
]
ignore = [
    "B905", # zip has no strict kwarg until Python 3.10
    "W505", # Doc line too long
    "E501", # Line too long
]

# Allow fix for all enabled rules (when `--fix`) is provided.
fixable = ["ALL"]
unfixable = []

# Allow unused variables when underscore-prefixed.
dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"

[tool.ruff.lint.pydocstyle]
convention = "google"

[tool.ruff.lint.isort]
lines-after-imports = 2
known-third-party = ["hopsworks", "hsfs", "hsml", "hopsworks_common"]


[tool.ruff.format]
# Like Black, use double quotes for strings.
quote-style = "double"

# Like Black, indent with spaces, rather than tabs.
indent-style = "space"

# Like Black, respect magic trailing commas.
skip-magic-trailing-comma = false

# Like Black, automatically detect the appropriate line ending.
line-ending = "auto"