McSAS3GUI/pyproject.toml at main · BAMresearch/McSAS3GUI · 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
[project]
name = "McSAS3GUI"
description = "A graphical user interface for the McSAS3 software."
dynamic = ["version", "readme"]
license = "MIT"
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 :: Implementation :: CPython",
  "Topic :: Utilities",
  "Topic :: Scientific/Engineering",
  "Intended Audience :: Developers",
  "Intended Audience :: Science/Research",
]
dependencies = [
    "PyQt6>=6.7.1",
    "mcsas3",
]

[[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/mcsas3gui"
documentation = "https://BAMresearch.github.io/mcsas3gui"
repository = "https://github.com/BAMresearch/mcsas3gui"
changelog = "https://BAMresearch.github.io/mcsas3gui/changelog.html"

[project.scripts]
mcsas3gui = "mcsas3gui.main:main"
m3gui = "mcsas3gui.main: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"]

[tool.setuptools.package-data]
mcsas3gui = ["resources/*.svg"]
"mcsas3gui.configurations" = ["*.yaml"]
"mcsas3gui.testdata" = ["*.dat", "*.csv", "*.nxs"]

[tool.setuptools.dynamic]
version = {attr = "mcsas3gui.__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]
allow_zero_version = true
version_variables = [                        # version location
    "src/mcsas3gui/__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 = 100
preview = true

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

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