stixpy/pyproject.toml at main · TCDSolar/stixpy · 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
137
138
139
140
141
142
[build-system]
requires = [
    "setuptools>=62.1",
    "setuptools_scm[toml]>=8.0.1",
    "wheel"
]
build-backend = 'setuptools.build_meta'

[project]
name = "stixpy"
description = "An open-source Python analysis library for the Spectrometer Telescope for Imaging X-rays (STIX) instrument on Solar Obriter."
requires-python = ">=3.12"
readme = {file = "README.rst", content-type="text/x-rst"}
license = "BSD-3-Clause"
license-files = ["LICENSE.rst"]
authors = [{name="Shane Maloney", email = "shane.maloney@dias.ie"}]
dependencies = [
    "sunpy[map,net,timeseries]>=7.0",
    "packaging>=23.2",
    "intervaltree",
    "roentgen<=2.4",
    "matplotlib>=3.8.0",
    "xrayvisim~=0.2.1"
]
dynamic = ["version"]
keywords = ["solar physics", "solar", "sun", "x-rays"]
classifiers = [
  "Development Status :: 3 - Alpha",
  "Intended Audience :: Science/Research",
  "Natural Language :: English",
  "Operating System :: OS Independent",
  "Programming Language :: Python",
  "Programming Language :: Python :: 3",
  "Programming Language :: Python :: 3.12",
  "Programming Language :: Python :: 3.13",
  "Programming Language :: Python :: 3.14",
  "Topic :: Scientific/Engineering :: Physics"
]

[project.optional-dependencies]
tests = [
    "matplotlib>=3.8.0",
    "pytest-astropy>=0.11.0",
    "pytest-mpl>=0.16",
    "pytest-xdist>=3.0.2",
    "pytest>=7.1.0"
]
docs = [
    "sphinx>=6.0.0",
    "sphinx-automodapi>=0.14.1",
    "packaging>=23.0",
    "sphinx-changelog>=1.5.0",
    "sphinx-design>=0.2.0",
    "sphinx-gallery>=0.13.0",
    "sphinxext-opengraph>=0.6.0",
    "stixpy[all]",
    "pydata-sphinx-theme>=0.16.0"
]
dev = ["stixpy[tests,docs]"]

[project.urls]
Homepage = "https://stixpy.readthedocs.io"
"Source Code" = "https://github.com/TCDSolar/stixpy"
Download = "https://pypi.org/project/stixpy"
Documentation = "https://stixpy.readthedocs.io"
Changelog = "https://stixpy.readthedocs.io/en/latest/whatsnew/changelog.html"
"Issue Tracker" = "https://github.com/TCDSolar/stixpy/issues"

[tool.setuptools]
zip-safe = false
include-package-data = true
platforms = ["any"]
provides = ["stixpy"]

[tool.setuptools.packages.find]
include = ["stixpy*"]
exclude = ["stixpy._dev*"]

[tool.setuptools.package-data]
xrayvisim = ["data/*"]

[tool.setuptools_scm]
version_file = "stixpy/_version.py"

[ tool.gilesbot ]

  [ tool.gilesbot.pull_requests ]
    enabled = true

  [ tool.gilesbot.towncrier_changelog ]
    enabled = true
    verify_pr_number = true
    changelog_skip_label = "No Changelog Entry Needed"
    help_url = "https://github.com/TCDSolar/stixpy/blob/main/changelog/README.rst"

    changelog_missing_long = "There isn't a changelog file in this pull request. Please add a changelog file to the `changelog/` directory following the instructions in the changelog [README](https://github.com/TCDSolar/stixpy/blob/main/changelog/README.rst)."

    type_incorrect_long = "The changelog file you added is not one of the allowed types. Please use one of the types described in the changelog [README](https://github.com/TCDSolar/stixpy/blob/main/changelog/README.rst)"

    number_incorrect_long = "The number in the changelog file you added does not match the number of this pull request. Please rename the file."


[tool.towncrier]
    package = "stixpy"
    filename = "CHANGELOG.rst"
    directory = "changelog/"
    issue_format = "`#{issue} <https://github.com/TCDSolar/stixpy/pull/{issue}>`__"

    [[tool.towncrier.type]]
        directory = "breaking"
        name = "Backwards Incompatible Changes"
        showcontent = true

    [[tool.towncrier.type]]
        directory = "api"
        name = "API Changes"
        showcontent = true

    [[tool.towncrier.type]]
      directory = "removal"
      name = "Deprecations and Removals"
      showcontent = true

    [[tool.towncrier.type]]
      directory = "feature"
      name = "Features"
      showcontent = true

    [[tool.towncrier.type]]
      directory = "bugfix"
      name = "Bug Fixes"
      showcontent = true

    [[tool.towncrier.type]]
      directory = "doc"
      name = "Improved Documentation"
      showcontent = true

    [[tool.towncrier.type]]
      directory = "trivial"
      name = "Trivial/Internal Changes"
      showcontent = true