fairswarm-library/pyproject.toml at main · dataeducator/fairswarm-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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "fairswarm"
dynamic = ["version"]
description = "Provably fair particle swarm optimization for federated learning coalition selection"
readme = "README.md"
license = "LicenseRef-PolyForm-Noncommercial-1.0.0"
requires-python = ">=3.9"
authors = [
    { name = "Tenicka Norwood", email = "tenicka.norwood@gmail.com" },
]
keywords = [
    "federated-learning",
    "particle-swarm-optimization",
    "fairness",
    "healthcare",
    "machine-learning",
]
classifiers = [
    "Development Status :: 3 - Alpha",
    "Intended Audience :: Science/Research",
    "License :: Other/Proprietary License",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.9",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Topic :: Scientific/Engineering :: Artificial Intelligence",
    "Typing :: Typed",
]

dependencies = [
    "numpy>=1.24.0",
    "scipy>=1.10.0",
    "pydantic>=2.0.0",
    "typing_extensions>=4.0.0; python_version < '3.10'",
]

[project.optional-dependencies]
dev = [
    "pytest>=7.4.0",
    "pytest-cov>=4.1.0",
    "hypothesis>=6.82.0",
    "mypy>=1.5.0",
    "ruff>=0.1.0",
    "pre-commit>=3.4.0",
]
flower = [
    "flwr>=1.5.0",
]
full = [
    "fairswarm[dev,flower]",
]

[project.urls]
Homepage = "https://github.com/dataeducator/fairswarm-library"
Documentation = "https://github.com/dataeducator/fairswarm-library#readme"
Issues = "https://github.com/dataeducator/fairswarm-library/issues"
Source = "https://github.com/dataeducator/fairswarm-library"

[tool.hatch.version]
path = "src/fairswarm/__version__.py"

[tool.hatch.build.targets.wheel]
packages = ["src/fairswarm"]

[tool.hatch.build.targets.sdist]
include = [
    "/src",
    "/tests",
]

[tool.pytest.ini_options]
testpaths = ["tests"]
addopts = "-v --tb=short"
pythonpath = ["src"]
markers = [
    "slow: marks tests as slow (deselect with '-m \"not slow\"')",
    "theorem1: tests for Theorem 1 (Convergence)",
    "theorem2: tests for Theorem 2 (ε-Fairness)",
    "theorem3: tests for Theorem 3 (Approximation)",
]

[tool.mypy]
python_version = "3.9"
strict = true
warn_return_any = true
warn_unused_configs = true
exclude = ["tests"]

[tool.ruff]
target-version = "py39"
line-length = 88

[tool.ruff.lint]
select = [
    "E",   # pycodestyle errors
    "W",   # pycodestyle warnings
    "F",   # pyflakes
    "I",   # isort
    "B",   # flake8-bugbear
    "C4",  # flake8-comprehensions
    "UP",  # pyupgrade
]
ignore = [
    "E402",  # module-level import not at top (needed for sys.path in experiments)
    "E501",  # line too long (handled by formatter)
]

[tool.ruff.lint.isort]
known-first-party = ["fairswarm"]

[tool.bandit]
exclude_dirs = ["tests", "experiments"]
skips = ["B101", "B311"]
# B101: assert used (fine in non-production code)
# B311: random used (acceptable for PSO stochastic optimization)

[tool.bandit.assert_used]
skips = ["*/test_*.py", "*/conftest.py"]

[tool.coverage.run]
source = ["fairswarm"]
omit = ["*/tests/*", "*/test_*.py"]

[tool.coverage.report]
fail_under = 80
show_missing = true
exclude_lines = [
    "pragma: no cover",
    "if TYPE_CHECKING:",
    "if __name__ == .__main__.",
]