McSAS3/pyproject.toml at main · BAMresearch/McSAS3 · 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
[project]
name = "mcsas3"
description = "A refactored McSAS for analysis of X-ray and Neutron scattering data."
dynamic = ["version", "readme"]
requires-python = ">=3.12"
license = "GPL-3.0-or-later"
classifiers = [
  # complete classifier list: http://pypi.python.org/pypi?%3Aaction=list_classifiers
  "Development Status :: 4 - Beta",
  "Operating System :: Unix",
  "Operating System :: POSIX",
  "Operating System :: MacOS",
  "Operating System :: Microsoft :: Windows",
  "Programming Language :: Python",
  "Programming Language :: Python :: 3",
  "Programming Language :: Python :: 3 :: Only",
  "Programming Language :: Python :: 3.12",
  "Programming Language :: Python :: 3.13",
  "Programming Language :: Python :: 3.14",
  "Programming Language :: Python :: Implementation :: CPython",
  "Framework :: Jupyter :: JupyterLab",
  "Topic :: Utilities",
  "Topic :: Scientific/Engineering",
  "Intended Audience :: Developers",
  "Intended Audience :: Science/Research",
]
dependencies = [
    "pyyaml",
    "pandas",
    "attrs",
    "h5py",
    "pint",
    "sasmodels",
    "modacor>=1.0.0",
]

[project.optional-dependencies]
standalone = [
    "pyinstaller>=6.19",
]

[[project.authors]]
name = "Brian R. Pauw"
email = "brian.pauw@bam.de"

[[project.authors]]
name = "Ingo Breßler"
email = "ingo.bressler@bam.de"

[project.urls]
homepage = "https://BAMresearch.github.io/McSAS3"
documentation = "https://BAMresearch.github.io/McSAS3"
repository = "https://github.com/BAMresearch/McSAS3"
changelog = "https://BAMresearch.github.io/McSAS3/changelog.html"

[project.scripts]
mcsas3-runner = "mcsas3.mcsas3_cli_runner:main"
mcsas3-histogrammer = "mcsas3.mcsas3_cli_histogrammer:main"

[build-system]
requires = [
    "setuptools>=40.6",
    "wheel",
]
# check-manifest checks that, https://github.com/mgedmin/check-manifest/commit/c9df78
build-backend = "setuptools.build_meta"

[tool.setuptools.packages.find]
where = ["src"]
include = ["mcsas3*"]

[tool.setuptools.dynamic]
version = {attr = "mcsas3.__version__"}
readme = {file = ["README.md", "CHANGELOG.md"], content-type = "text/markdown"}

[tool.coverage.report]
path = "coverage-report"  # see coverage.yml github action

# on version numbers: https://peps.python.org/pep-0440/
# and bottom of https://softwareengineering.stackexchange.com/a/151558
[tool.semantic_release]
#major_on_zero = false # no major release when current major version is zero
version_variables = [                        # version location
    "src/mcsas3/__init__.py:__version__",
    "docs/conf.py:version",
]
[tool.semantic_release.commit_parser_options]
allowed_tags = ["build", "chore", "ci", "docs", "feat", "enh", "fix", "perf", "style", "refactor", "test"]
minor_tags = ["feat", "enh"]
patch_tags = ["fix", "perf"]
[tool.semantic_release.changelog]
exclude_commit_patterns = ["chore", ".*\\bGHA\\b.*", ".*\\b[gG][hH] actions?\\b.*"]
[tool.semantic_release.publish]
upload_to_vcs_release = false

[tool.black]
line-length = 120
preview = true

[tool.isort]
profile = "black"
line_length = 120
group_by_package = true
known_first_party = "mcsas3"
ensure_newline_before_comments = true
extend_skip = ["ci/templates", ".ipynb_checkpoints"]

[tool.ruff]
line-length = 120
target-version = "py312"
extend-exclude = ["ci/templates", ".ipynb_checkpoints", "notebooks"]

[tool.ruff.lint]
select = ["E", "F", "W", "I"]
ignore = ["E203"]

[tool.ruff.format]
quote-style = "double"
indent-style = "space"
skip-magic-trailing-comma = false
line-ending = "auto"

[tool.docformatter]
recursive = true
wrap-summaries = 120
wrap-descriptions = 120