dkist-processing-common 10.6.1rc2__py3-none-any.whl → 10.6.1rc4__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (21) hide show
  1. changelog/236.misc.1.rst +2 -1
  2. changelog/236.misc.rst +3 -1
  3. dkist_processing_common/models/graphql.py +22 -2
  4. dkist_processing_common/tasks/mixin/metadata_store.py +5 -6
  5. dkist_processing_common/tasks/output_data_base.py +1 -1
  6. dkist_processing_common/tasks/teardown.py +1 -1
  7. dkist_processing_common/tasks/transfer_input_data.py +4 -3
  8. dkist_processing_common/tasks/trial_output_data.py +12 -11
  9. dkist_processing_common/tasks/write_l1.py +3 -3
  10. dkist_processing_common/tests/conftest.py +94 -61
  11. dkist_processing_common/tests/test_input_dataset.py +2 -20
  12. dkist_processing_common/tests/test_teardown.py +16 -15
  13. dkist_processing_common/tests/test_transfer_input_data.py +74 -118
  14. dkist_processing_common/tests/test_trial_catalog.py +2 -2
  15. dkist_processing_common/tests/test_trial_output_data.py +9 -11
  16. dkist_processing_common/tests/test_write_l1.py +14 -2
  17. dkist_processing_common-10.6.1rc4.dist-info/METADATA +175 -0
  18. {dkist_processing_common-10.6.1rc2.dist-info → dkist_processing_common-10.6.1rc4.dist-info}/RECORD +20 -20
  19. {dkist_processing_common-10.6.1rc2.dist-info → dkist_processing_common-10.6.1rc4.dist-info}/WHEEL +1 -1
  20. dkist_processing_common-10.6.1rc2.dist-info/METADATA +0 -398
  21. {dkist_processing_common-10.6.1rc2.dist-info → dkist_processing_common-10.6.1rc4.dist-info}/top_level.txt +0 -0
dkist_processing_common-10.6.1rc2.dist-info/METADATA DELETED
@@ -1,398 +0,0 @@
1
- Metadata-Version: 2.2
2
- Name: dkist-processing-common
3
- Version: 10.6.1rc2
4
- Summary: Common task classes used by the DKIST science data processing pipelines
5
- Author-email: NSO / AURA <dkistdc@nso.edu>
6
- License: BSD-3-Clause
7
- Project-URL: Homepage, https://nso.edu/dkist/data-center/
8
- Project-URL: Repository, https://bitbucket.org/dkistdc/dkist-processing-common/
9
- Project-URL: Documentation, https://docs.dkist.nso.edu/projects/common
10
- Project-URL: Help, https://nso.atlassian.net/servicedesk/customer/portal/5
11
- Classifier: Programming Language :: Python
12
- Classifier: Programming Language :: Python :: 3
13
- Classifier: Programming Language :: Python :: 3.11
14
- Requires-Python: >=3.11
15
- Description-Content-Type: text/x-rst
16
- Requires-Dist: asdf<4.0.0,>=3.5.0
17
- Requires-Dist: astropy<7.0.0,>=6.0.0
18
- Requires-Dist: dkist-fits-specifications<5.0,>=4.0.0
19
- Requires-Dist: dkist-header-validator<6.0,>=5.0.0
20
- Requires-Dist: dkist-processing-core==5.1.0
21
- Requires-Dist: dkist-processing-pac<4.0,>=3.1
22
- Requires-Dist: dkist-service-configuration<3.0,>=2.0.2
23
- Requires-Dist: dkist-spectral-lines<4.0,>=3.0.0
24
- Requires-Dist: globus-sdk>=3.12.0
25
- Requires-Dist: gqlclient==1.2.3
26
- Requires-Dist: sqids==0.5.1
27
- Requires-Dist: matplotlib>=3.4
28
- Requires-Dist: moviepy>=2.0.0
29
- Requires-Dist: numpy>=1.20.2
30
- Requires-Dist: object-clerk==0.1.1
31
- Requires-Dist: pandas>=1.4.2
32
- Requires-Dist: pillow>=10.2.0
33
- Requires-Dist: pydantic>=2.0
34
- Requires-Dist: redis==4.6.0
35
- Requires-Dist: requests>=2.23
36
- Requires-Dist: scipy>=1.15.1
37
- Requires-Dist: sunpy>=3.0.0
38
- Requires-Dist: talus==1.1.0
39
- Provides-Extra: test
40
- Requires-Dist: pytest; extra == "test"
41
- Requires-Dist: pytest-xdist; extra == "test"
42
- Requires-Dist: pytest-cov; extra == "test"
43
- Requires-Dist: pytest-mock; extra == "test"
44
- Requires-Dist: hypothesis; extra == "test"
45
- Requires-Dist: towncrier; extra == "test"
46
- Requires-Dist: dkist-data-simulator>=5.0.0; extra == "test"
47
- Requires-Dist: dkist-processing-common[inventory]; extra == "test"
48
- Requires-Dist: dkist-processing-common[asdf]; extra == "test"
49
- Requires-Dist: dkist-processing-common[quality]; extra == "test"
50
- Provides-Extra: docs
51
- Requires-Dist: sphinx; extra == "docs"
52
- Requires-Dist: sphinx-astropy; extra == "docs"
53
- Requires-Dist: sphinx-changelog; extra == "docs"
54
- Requires-Dist: sphinx-autoapi!=3.1.0; extra == "docs"
55
- Requires-Dist: pytest; extra == "docs"
56
- Requires-Dist: towncrier<22.12.0; extra == "docs"
57
- Requires-Dist: dkist-sphinx-theme; extra == "docs"
58
- Provides-Extra: inventory
59
- Requires-Dist: dkist-inventory<2.0,>=1.6.0; extra == "inventory"
60
- Provides-Extra: asdf
61
- Requires-Dist: dkist-inventory[asdf]<2.0,>=1.6.0; extra == "asdf"
62
- Provides-Extra: quality
63
- Requires-Dist: dkist-quality<2.0,>=1.2.1; extra == "quality"
64
- Provides-Extra: frozen
65
- Requires-Dist: ConfigUpdater==3.2; extra == "frozen"
66
- Requires-Dist: Deprecated==1.2.18; extra == "frozen"
67
- Requires-Dist: Flask==2.2.5; extra == "frozen"
68
- Requires-Dist: Flask-AppBuilder==4.5.3; extra == "frozen"
69
- Requires-Dist: Flask-Babel==2.0.0; extra == "frozen"
70
- Requires-Dist: Flask-Caching==2.3.1; extra == "frozen"
71
- Requires-Dist: Flask-JWT-Extended==4.7.1; extra == "frozen"
72
- Requires-Dist: Flask-Limiter==3.10.1; extra == "frozen"
73
- Requires-Dist: Flask-Login==0.6.3; extra == "frozen"
74
- Requires-Dist: Flask-SQLAlchemy==2.5.1; extra == "frozen"
75
- Requires-Dist: Flask-Session==0.5.0; extra == "frozen"
76
- Requires-Dist: Flask-WTF==1.2.2; extra == "frozen"
77
- Requires-Dist: Jinja2==3.1.5; extra == "frozen"
78
- Requires-Dist: Mako==1.3.9; extra == "frozen"
79
- Requires-Dist: MarkupSafe==3.0.2; extra == "frozen"
80
- Requires-Dist: PyJWT==2.10.1; extra == "frozen"
81
- Requires-Dist: PyYAML==6.0.2; extra == "frozen"
82
- Requires-Dist: Pygments==2.19.1; extra == "frozen"
83
- Requires-Dist: SQLAlchemy==1.4.54; extra == "frozen"
84
- Requires-Dist: SQLAlchemy-JSONField==1.0.2; extra == "frozen"
85
- Requires-Dist: SQLAlchemy-Utils==0.41.2; extra == "frozen"
86
- Requires-Dist: WTForms==3.2.1; extra == "frozen"
87
- Requires-Dist: Werkzeug==2.2.3; extra == "frozen"
88
- Requires-Dist: aioftp==0.24.1; extra == "frozen"
89
- Requires-Dist: aiohappyeyeballs==2.4.8; extra == "frozen"
90
- Requires-Dist: aiohttp==3.11.13; extra == "frozen"
91
- Requires-Dist: aiosignal==1.3.2; extra == "frozen"
92
- Requires-Dist: aiosqlite==0.21.0; extra == "frozen"
93
- Requires-Dist: alembic==1.15.1; extra == "frozen"
94
- Requires-Dist: amqp==5.3.1; extra == "frozen"
95
- Requires-Dist: annotated-types==0.7.0; extra == "frozen"
96
- Requires-Dist: anyio==4.8.0; extra == "frozen"
97
- Requires-Dist: apache-airflow==2.10.5; extra == "frozen"
98
- Requires-Dist: apache-airflow-providers-celery==3.10.0; extra == "frozen"
99
- Requires-Dist: apache-airflow-providers-common-compat==1.5.0; extra == "frozen"
100
- Requires-Dist: apache-airflow-providers-common-io==1.5.0; extra == "frozen"
101
- Requires-Dist: apache-airflow-providers-common-sql==1.23.0; extra == "frozen"
102
- Requires-Dist: apache-airflow-providers-fab==1.5.3; extra == "frozen"
103
- Requires-Dist: apache-airflow-providers-ftp==3.12.2; extra == "frozen"
104
- Requires-Dist: apache-airflow-providers-http==5.2.0; extra == "frozen"
105
- Requires-Dist: apache-airflow-providers-imap==3.8.2; extra == "frozen"
106
- Requires-Dist: apache-airflow-providers-postgres==6.1.0; extra == "frozen"
107
- Requires-Dist: apache-airflow-providers-smtp==2.0.0; extra == "frozen"
108
- Requires-Dist: apache-airflow-providers-sqlite==4.0.0; extra == "frozen"
109
- Requires-Dist: apispec==6.8.1; extra == "frozen"
110
- Requires-Dist: argcomplete==3.5.3; extra == "frozen"
111
- Requires-Dist: asdf==3.5.0; extra == "frozen"
112
- Requires-Dist: asdf_standard==1.1.1; extra == "frozen"
113
- Requires-Dist: asdf_transform_schemas==0.5.0; extra == "frozen"
114
- Requires-Dist: asgiref==3.8.1; extra == "frozen"
115
- Requires-Dist: asteval==1.0.6; extra == "frozen"
116
- Requires-Dist: astropy==6.1.7; extra == "frozen"
117
- Requires-Dist: astropy-iers-data==0.2025.3.3.0.34.45; extra == "frozen"
118
- Requires-Dist: asyncpg==0.30.0; extra == "frozen"
119
- Requires-Dist: attrs==25.1.0; extra == "frozen"
120
- Requires-Dist: babel==2.17.0; extra == "frozen"
121
- Requires-Dist: billiard==4.2.1; extra == "frozen"
122
- Requires-Dist: blinker==1.9.0; extra == "frozen"
123
- Requires-Dist: boto3==1.37.6; extra == "frozen"
124
- Requires-Dist: botocore==1.37.6; extra == "frozen"
125
- Requires-Dist: cachelib==0.13.0; extra == "frozen"
126
- Requires-Dist: celery==5.4.0; extra == "frozen"
127
- Requires-Dist: certifi==2025.1.31; extra == "frozen"
128
- Requires-Dist: cffi==1.17.1; extra == "frozen"
129
- Requires-Dist: charset-normalizer==3.4.1; extra == "frozen"
130
- Requires-Dist: click==8.1.8; extra == "frozen"
131
- Requires-Dist: click-didyoumean==0.3.1; extra == "frozen"
132
- Requires-Dist: click-plugins==1.1.1; extra == "frozen"
133
- Requires-Dist: click-repl==0.3.0; extra == "frozen"
134
- Requires-Dist: clickclick==20.10.2; extra == "frozen"
135
- Requires-Dist: colorama==0.4.6; extra == "frozen"
136
- Requires-Dist: colorlog==6.9.0; extra == "frozen"
137
- Requires-Dist: connexion==2.14.2; extra == "frozen"
138
- Requires-Dist: contourpy==1.3.1; extra == "frozen"
139
- Requires-Dist: cron-descriptor==1.4.5; extra == "frozen"
140
- Requires-Dist: croniter==6.0.0; extra == "frozen"
141
- Requires-Dist: cryptography==44.0.2; extra == "frozen"
142
- Requires-Dist: cycler==0.12.1; extra == "frozen"
143
- Requires-Dist: dacite==1.9.2; extra == "frozen"
144
- Requires-Dist: decorator==5.2.1; extra == "frozen"
145
- Requires-Dist: dill==0.3.9; extra == "frozen"
146
- Requires-Dist: dkist-header-validator==5.1.1; extra == "frozen"
147
- Requires-Dist: dkist-processing-common==10.6.1rc2; extra == "frozen"
148
- Requires-Dist: dkist-processing-core==5.1.0; extra == "frozen"
149
- Requires-Dist: dkist-processing-pac==3.1.1; extra == "frozen"
150
- Requires-Dist: dkist-service-configuration==2.3.0; extra == "frozen"
151
- Requires-Dist: dkist-spectral-lines==3.0.0; extra == "frozen"
152
- Requires-Dist: dkist_fits_specifications==4.11.0; extra == "frozen"
153
- Requires-Dist: dnspython==2.7.0; extra == "frozen"
154
- Requires-Dist: ecs-logging==2.2.0; extra == "frozen"
155
- Requires-Dist: elastic-apm==6.23.0; extra == "frozen"
156
- Requires-Dist: email_validator==2.2.0; extra == "frozen"
157
- Requires-Dist: fastjsonschema==2.21.1; extra == "frozen"
158
- Requires-Dist: flower==2.0.1; extra == "frozen"
159
- Requires-Dist: fonttools==4.56.0; extra == "frozen"
160
- Requires-Dist: frozenlist==1.5.0; extra == "frozen"
161
- Requires-Dist: fsspec==2025.2.0; extra == "frozen"
162
- Requires-Dist: globus-sdk==3.50.0; extra == "frozen"
163
- Requires-Dist: google-re2==1.1.20240702; extra == "frozen"
164
- Requires-Dist: googleapis-common-protos==1.69.0; extra == "frozen"
165
- Requires-Dist: gqlclient==1.2.3; extra == "frozen"
166
- Requires-Dist: greenlet==3.1.1; extra == "frozen"
167
- Requires-Dist: grpcio==1.70.0; extra == "frozen"
168
- Requires-Dist: gunicorn==23.0.0; extra == "frozen"
169
- Requires-Dist: h11==0.14.0; extra == "frozen"
170
- Requires-Dist: httpcore==1.0.7; extra == "frozen"
171
- Requires-Dist: httpx==0.28.1; extra == "frozen"
172
- Requires-Dist: humanize==4.12.1; extra == "frozen"
173
- Requires-Dist: idna==3.10; extra == "frozen"
174
- Requires-Dist: imageio==2.37.0; extra == "frozen"
175
- Requires-Dist: imageio-ffmpeg==0.6.0; extra == "frozen"
176
- Requires-Dist: importlib_metadata==8.5.0; extra == "frozen"
177
- Requires-Dist: inflection==0.5.1; extra == "frozen"
178
- Requires-Dist: itsdangerous==2.2.0; extra == "frozen"
179
- Requires-Dist: jmespath==1.0.1; extra == "frozen"
180
- Requires-Dist: jsonschema==4.23.0; extra == "frozen"
181
- Requires-Dist: jsonschema-specifications==2024.10.1; extra == "frozen"
182
- Requires-Dist: jupyter_core==5.7.2; extra == "frozen"
183
- Requires-Dist: kiwisolver==1.4.8; extra == "frozen"
184
- Requires-Dist: kombu==5.4.2; extra == "frozen"
185
- Requires-Dist: lazy-object-proxy==1.10.0; extra == "frozen"
186
- Requires-Dist: limits==4.0.1; extra == "frozen"
187
- Requires-Dist: linkify-it-py==2.0.3; extra == "frozen"
188
- Requires-Dist: lmfit==1.3.2; extra == "frozen"
189
- Requires-Dist: lockfile==0.12.2; extra == "frozen"
190
- Requires-Dist: loguru==0.7.3; extra == "frozen"
191
- Requires-Dist: markdown-it-py==3.0.0; extra == "frozen"
192
- Requires-Dist: marshmallow==3.26.1; extra == "frozen"
193
- Requires-Dist: marshmallow-oneofschema==3.1.1; extra == "frozen"
194
- Requires-Dist: marshmallow-sqlalchemy==0.28.2; extra == "frozen"
195
- Requires-Dist: matplotlib==3.10.1; extra == "frozen"
196
- Requires-Dist: mdit-py-plugins==0.4.2; extra == "frozen"
197
- Requires-Dist: mdurl==0.1.2; extra == "frozen"
198
- Requires-Dist: methodtools==0.4.7; extra == "frozen"
199
- Requires-Dist: more-itertools==10.6.0; extra == "frozen"
200
- Requires-Dist: moviepy==2.1.2; extra == "frozen"
201
- Requires-Dist: multidict==6.1.0; extra == "frozen"
202
- Requires-Dist: nbformat==5.10.4; extra == "frozen"
203
- Requires-Dist: numpy==2.2.3; extra == "frozen"
204
- Requires-Dist: object-clerk==0.1.1; extra == "frozen"
205
- Requires-Dist: opentelemetry-api==1.30.0; extra == "frozen"
206
- Requires-Dist: opentelemetry-exporter-otlp==1.30.0; extra == "frozen"
207
- Requires-Dist: opentelemetry-exporter-otlp-proto-common==1.30.0; extra == "frozen"
208
- Requires-Dist: opentelemetry-exporter-otlp-proto-grpc==1.30.0; extra == "frozen"
209
- Requires-Dist: opentelemetry-exporter-otlp-proto-http==1.30.0; extra == "frozen"
210
- Requires-Dist: opentelemetry-proto==1.30.0; extra == "frozen"
211
- Requires-Dist: opentelemetry-sdk==1.30.0; extra == "frozen"
212
- Requires-Dist: opentelemetry-semantic-conventions==0.51b0; extra == "frozen"
213
- Requires-Dist: ordered-set==4.1.0; extra == "frozen"
214
- Requires-Dist: packaging==24.2; extra == "frozen"
215
- Requires-Dist: pandas==2.2.3; extra == "frozen"
216
- Requires-Dist: parfive==2.1.0; extra == "frozen"
217
- Requires-Dist: pathspec==0.12.1; extra == "frozen"
218
- Requires-Dist: pendulum==3.0.0; extra == "frozen"
219
- Requires-Dist: pika==1.3.2; extra == "frozen"
220
- Requires-Dist: pillow==10.4.0; extra == "frozen"
221
- Requires-Dist: pip==25.0.1; extra == "frozen"
222
- Requires-Dist: platformdirs==4.3.6; extra == "frozen"
223
- Requires-Dist: pluggy==1.5.0; extra == "frozen"
224
- Requires-Dist: prison==0.2.1; extra == "frozen"
225
- Requires-Dist: proglog==0.1.10; extra == "frozen"
226
- Requires-Dist: prometheus_client==0.21.1; extra == "frozen"
227
- Requires-Dist: prompt_toolkit==3.0.50; extra == "frozen"
228
- Requires-Dist: propcache==0.3.0; extra == "frozen"
229
- Requires-Dist: protobuf==5.29.3; extra == "frozen"
230
- Requires-Dist: psutil==7.0.0; extra == "frozen"
231
- Requires-Dist: psycopg2-binary==2.9.10; extra == "frozen"
232
- Requires-Dist: py==1.11.0; extra == "frozen"
233
- Requires-Dist: pycparser==2.22; extra == "frozen"
234
- Requires-Dist: pydantic==2.10.6; extra == "frozen"
235
- Requires-Dist: pydantic-settings==2.8.1; extra == "frozen"
236
- Requires-Dist: pydantic_core==2.27.2; extra == "frozen"
237
- Requires-Dist: pyerfa==2.0.1.5; extra == "frozen"
238
- Requires-Dist: pyparsing==3.2.1; extra == "frozen"
239
- Requires-Dist: python-daemon==3.1.2; extra == "frozen"
240
- Requires-Dist: python-dateutil==2.9.0.post0; extra == "frozen"
241
- Requires-Dist: python-dotenv==1.0.1; extra == "frozen"
242
- Requires-Dist: python-nvd3==0.16.0; extra == "frozen"
243
- Requires-Dist: python-slugify==8.0.4; extra == "frozen"
244
- Requires-Dist: pytz==2025.1; extra == "frozen"
245
- Requires-Dist: redis==4.6.0; extra == "frozen"
246
- Requires-Dist: referencing==0.36.2; extra == "frozen"
247
- Requires-Dist: requests==2.32.3; extra == "frozen"
248
- Requires-Dist: requests-toolbelt==1.0.0; extra == "frozen"
249
- Requires-Dist: retry==0.9.2; extra == "frozen"
250
- Requires-Dist: rfc3339-validator==0.1.4; extra == "frozen"
251
- Requires-Dist: rich==13.9.4; extra == "frozen"
252
- Requires-Dist: rich-argparse==1.7.0; extra == "frozen"
253
- Requires-Dist: rpds-py==0.23.1; extra == "frozen"
254
- Requires-Dist: s3transfer==0.11.4; extra == "frozen"
255
- Requires-Dist: scipy==1.15.2; extra == "frozen"
256
- Requires-Dist: semantic-version==2.10.0; extra == "frozen"
257
- Requires-Dist: setproctitle==1.3.5; extra == "frozen"
258
- Requires-Dist: setuptools==65.5.0; extra == "frozen"
259
- Requires-Dist: six==1.17.0; extra == "frozen"
260
- Requires-Dist: sniffio==1.3.1; extra == "frozen"
261
- Requires-Dist: sqids==0.5.1; extra == "frozen"
262
- Requires-Dist: sqlparse==0.5.3; extra == "frozen"
263
- Requires-Dist: sunpy==6.1.1; extra == "frozen"
264
- Requires-Dist: tabulate==0.9.0; extra == "frozen"
265
- Requires-Dist: talus==1.1.0; extra == "frozen"
266
- Requires-Dist: tenacity==9.0.0; extra == "frozen"
267
- Requires-Dist: termcolor==2.5.0; extra == "frozen"
268
- Requires-Dist: text-unidecode==1.3; extra == "frozen"
269
- Requires-Dist: time-machine==2.16.0; extra == "frozen"
270
- Requires-Dist: tornado==6.4.2; extra == "frozen"
271
- Requires-Dist: tqdm==4.67.1; extra == "frozen"
272
- Requires-Dist: traitlets==5.14.3; extra == "frozen"
273
- Requires-Dist: typing_extensions==4.12.2; extra == "frozen"
274
- Requires-Dist: tzdata==2025.1; extra == "frozen"
275
- Requires-Dist: uc-micro-py==1.0.3; extra == "frozen"
276
- Requires-Dist: uncertainties==3.2.2; extra == "frozen"
277
- Requires-Dist: universal_pathlib==0.2.6; extra == "frozen"
278
- Requires-Dist: urllib3==2.3.0; extra == "frozen"
279
- Requires-Dist: vine==5.1.0; extra == "frozen"
280
- Requires-Dist: voluptuous==0.15.2; extra == "frozen"
281
- Requires-Dist: wcwidth==0.2.13; extra == "frozen"
282
- Requires-Dist: wirerope==1.0.0; extra == "frozen"
283
- Requires-Dist: wrapt==1.17.2; extra == "frozen"
284
- Requires-Dist: yamale==6.0.0; extra == "frozen"
285
- Requires-Dist: yarl==1.18.3; extra == "frozen"
286
- Requires-Dist: zipp==3.21.0; extra == "frozen"
287
-
288
- dkist-processing-common
289
- =======================
290
-
291
- This repository works in concert with `dkist-processing-core <https://pypi.org/project/dkist-processing-core/>`_ and `dkist-processing-*instrument*` to
292
- form the DKIST calibration processing stack.
293
-
294
- Usage
295
- -----
296
-
297
- The classes in this repository should be used as the base of any DKIST processing pipeline tasks. Science tasks should subclass `ScienceTaskL0ToL1Base`.
298
-
299
- Each class is built on an abstract base class with the `run` method left for a developer to fill out with the required steps that the task should take.
300
- This class is then used as the callable object for the workflow and scheduling engine.
301
-
302
- Example
303
- -------
304
-
305
- .. code-block:: python
306
-
307
- from dkist_processing_common.tasks.base import ScienceTaskL0ToL1Base
308
-
309
-
310
- class RemoveArtifacts(ScienceTaskL0ToL1Base):
311
- def run(self):
312
- # task code here
313
- total = 2 + 5
314
-
315
- Deployment
316
- ----------
317
-
318
- dkist-processing-common is deployed to `PyPI <https://pypi.org/project/dkist-processing-common/>`_
319
-
320
- Development
321
- -----------
322
-
323
- There are two prerequisites for test execution on a local machine:
324
-
325
-
326
- * Redis. A running instance of redis on the local machine is required. The tests will use the default host ip of localhost and port of 6379 to connect to the database.
327
-
328
- * RabbitMQ. A running instance of rabbitmq on the local machine is required. The tests will use the default host of localhost and a port of 5672 to connect to the interservice bus.
329
-
330
-
331
- To run the tests locally, clone the repository and install the package in editable mode with the test extras.
332
-
333
-
334
- .. code-block:: bash
335
-
336
- git clone git@bitbucket.org:dkistdc/dkist-processing-common.git
337
- cd dkist-processing-common
338
- pre-commit install
339
- pip install -e .[test]
340
- # Redis must be running
341
- pytest -v --cov dkist_processing_common
342
-
343
- Changelog
344
- #########
345
-
346
- When you make **any** change to this repository it **MUST** be accompanied by a changelog file.
347
- The changelog for this repository uses the `towncrier <https://github.com/twisted/towncrier>`__ package.
348
- Entries in the changelog for the next release are added as individual files (one per change) to the ``changelog/`` directory.
349
-
350
- Writing a Changelog Entry
351
- ^^^^^^^^^^^^^^^^^^^^^^^^^
352
-
353
- A changelog entry accompanying a change should be added to the ``changelog/`` directory.
354
- The name of a file in this directory follows a specific template::
355
-
356
- <PULL REQUEST NUMBER>.<TYPE>[.<COUNTER>].rst
357
-
358
- The fields have the following meanings:
359
-
360
- * ``<PULL REQUEST NUMBER>``: This is the number of the pull request, so people can jump from the changelog entry to the diff on BitBucket.
361
- * ``<TYPE>``: This is the type of the change and must be one of the values described below.
362
- * ``<COUNTER>``: This is an optional field, if you make more than one change of the same type you can append a counter to the subsequent changes, i.e. ``100.bugfix.rst`` and ``100.bugfix.1.rst`` for two bugfix changes in the same PR.
363
-
364
- The list of possible types is defined the the towncrier section of ``pyproject.toml``, the types are:
365
-
366
- * ``feature``: This change is a new code feature.
367
- * ``bugfix``: This is a change which fixes a bug.
368
- * ``doc``: A documentation change.
369
- * ``removal``: A deprecation or removal of public API.
370
- * ``misc``: Any small change which doesn't fit anywhere else, such as a change to the package infrastructure.
371
-
372
-
373
- Rendering the Changelog at Release Time
374
- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
375
-
376
- When you are about to tag a release first you must run ``towncrier`` to render the changelog.
377
- The steps for this are as follows:
378
-
379
- * Run `towncrier build --version vx.y.z` using the version number you want to tag.
380
- * Agree to have towncrier remove the fragments.
381
- * Add and commit your changes.
382
- * Tag the release.
383
-
384
- **NOTE:** If you forget to add a Changelog entry to a tagged release (either manually or automatically with ``towncrier``)
385
- then the Bitbucket pipeline will fail. To be able to use the same tag you must delete it locally and on the remote branch:
386
-
387
- .. code-block:: bash
388
-
389
- # First, actually update the CHANGELOG and commit the update
390
- git commit
391
-
392
- # Delete tags
393
- git tag -d vWHATEVER.THE.VERSION
394
- git push --delete origin vWHATEVER.THE.VERSION
395
-
396
- # Re-tag with the same version
397
- git tag vWHATEVER.THE.VERSION
398
- git push --tags origin main