| Name | dkist-processing-test JSON |
| Version |
1.34.0
JSON |
| download |
| home_page | None |
| Summary | Example instrument code used by the DKIST science data processing pipelines to test processing infrastructure |
| upload_time | 2025-07-18 18:47:00 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | BSD-3-Clause |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
dkist-processing-test
---------------------
|codecov|
Overview
--------
The dkist-processing-test library serves as an example implementation of a Tasks and Workflows using the
`dkist-processing-core <https://pypi.org/project/dkist-processing-core/>`_ framework and
`dkist-processing-common <https://pypi.org/project/dkist-processing-common/>`_ Tasks.
The recommended project structure is to separate tasks and workflows into separate packages.
Build
-----
Artifacts are built through `bitbucket pipelines <bitbucket-pipelines.yml>`_
The pipeline can be used in other repos with a modification of the package and artifact locations
to use the names relevant to the target repo.
e.g. dkist-processing-test -> dkist-processing-vbi and dkist_processing_test -> dkist_processing_vbi
Deployment
----------
Deployment is done with `turtlebot <https://bitbucket.org/dkistdc/turtlebot/src/master/>`_ and follows
the process detailed in `dkist-processing-core <https://pypi.org/project/dkist-processing-core/>`_
Environment Variables
---------------------
Only those specified by `dkist-processing-core <https://pypi.org/project/dkist-processing-core/>`_ and `dkist-processing-common <https://pypi.org/project/dkist-processing-common/>`_
Development
-----------
.. code-block:: bash
git clone git@bitbucket.org:dkistdc/dkist-processing-test.git
cd dkist-processing-test
pre-commit install
pip install -e .[test]
pytest -v --cov dkist_processing_test
Deployment
----------
When a new release is ready to be built the following steps need to be taken:
1. Freezing Dependencies
#########################
A new "frozen" extra is generated by the `dkist-dev-tools <https://bitbucket.org/dkistdc/dkist-dev-tools/src/main/>`_
package. If you don't have `dkist-dev-tools` installed please follow the directions from that repo.
To freeze dependencies run
.. code-block:: bash
ddt freeze vX.Y.Z[rcK]
Where "vX.Y.Z[rcK]" is the version about to be released.
2. Tag and Push
###############
Once all commits are in place add a git tag that will define the released version, then push the tags up to Bitbucket:
.. code-block:: bash
git tag vX.Y.Z[rcK]
git push --tags origin BRANCH
In the case of an rc, BRANCH will likely be your development branch. For full releases BRANCH should be "main".
.. |codecov| image:: https://codecov.io/bb/dkistdc/dkist-processing-test/graph/badge.svg?token=U004CWS46G
:target: https://codecov.io/bb/dkistdc/dkist-processing-test
Raw data
{
"_id": null,
"home_page": null,
"name": "dkist-processing-test",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "NSO / AURA <dkistdc@nso.edu>",
"download_url": "https://files.pythonhosted.org/packages/95/1b/a0885dad530b4d865aedbfa6598edd4375e2a5796feb0e32528793fe4cad/dkist_processing_test-1.34.0.tar.gz",
"platform": null,
"description": "dkist-processing-test\n---------------------\n\n|codecov|\n\nOverview\n--------\nThe dkist-processing-test library serves as an example implementation of a Tasks and Workflows using the\n`dkist-processing-core <https://pypi.org/project/dkist-processing-core/>`_ framework and\n`dkist-processing-common <https://pypi.org/project/dkist-processing-common/>`_ Tasks.\n\nThe recommended project structure is to separate tasks and workflows into separate packages.\n\nBuild\n-----\nArtifacts are built through `bitbucket pipelines <bitbucket-pipelines.yml>`_\n\nThe pipeline can be used in other repos with a modification of the package and artifact locations\nto use the names relevant to the target repo.\n\ne.g. dkist-processing-test -> dkist-processing-vbi and dkist_processing_test -> dkist_processing_vbi\n\nDeployment\n----------\nDeployment is done with `turtlebot <https://bitbucket.org/dkistdc/turtlebot/src/master/>`_ and follows\nthe process detailed in `dkist-processing-core <https://pypi.org/project/dkist-processing-core/>`_\n\nEnvironment Variables\n---------------------\nOnly those specified by `dkist-processing-core <https://pypi.org/project/dkist-processing-core/>`_ and `dkist-processing-common <https://pypi.org/project/dkist-processing-common/>`_\n\nDevelopment\n-----------\n\n.. code-block:: bash\n\n git clone git@bitbucket.org:dkistdc/dkist-processing-test.git\n cd dkist-processing-test\n pre-commit install\n pip install -e .[test]\n pytest -v --cov dkist_processing_test\n\nDeployment\n----------\n\nWhen a new release is ready to be built the following steps need to be taken:\n\n1. Freezing Dependencies\n#########################\n\nA new \"frozen\" extra is generated by the `dkist-dev-tools <https://bitbucket.org/dkistdc/dkist-dev-tools/src/main/>`_\npackage. If you don't have `dkist-dev-tools` installed please follow the directions from that repo.\n\nTo freeze dependencies run\n\n.. code-block:: bash\n\n ddt freeze vX.Y.Z[rcK]\n\nWhere \"vX.Y.Z[rcK]\" is the version about to be released.\n\n2. Tag and Push\n###############\n\nOnce all commits are in place add a git tag that will define the released version, then push the tags up to Bitbucket:\n\n.. code-block:: bash\n\n git tag vX.Y.Z[rcK]\n git push --tags origin BRANCH\n\nIn the case of an rc, BRANCH will likely be your development branch. For full releases BRANCH should be \"main\".\n\n.. |codecov| image:: https://codecov.io/bb/dkistdc/dkist-processing-test/graph/badge.svg?token=U004CWS46G\n :target: https://codecov.io/bb/dkistdc/dkist-processing-test\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Example instrument code used by the DKIST science data processing pipelines to test processing infrastructure",
"version": "1.34.0",
"project_urls": {
"Help": "https://nso.atlassian.net/servicedesk/customer/portal/5",
"Homepage": "https://nso.edu/dkist/data-center/",
"Repository": "https://bitbucket.org/dkistdc/dkist-processing-test/"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "fc3672cf03cc9df23c075a8c4017391bc863a51b022e692fcb1315bfa53af7c3",
"md5": "b8cd7cf32e678c56ed62fc55faffa136",
"sha256": "bd3c55a97dadb109b0144d7ef38d54cba8b533f3ec920db73100ae4d20335d34"
},
"downloads": -1,
"filename": "dkist_processing_test-1.34.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b8cd7cf32e678c56ed62fc55faffa136",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 28917,
"upload_time": "2025-07-18T18:46:58",
"upload_time_iso_8601": "2025-07-18T18:46:58.377991Z",
"url": "https://files.pythonhosted.org/packages/fc/36/72cf03cc9df23c075a8c4017391bc863a51b022e692fcb1315bfa53af7c3/dkist_processing_test-1.34.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "951ba0885dad530b4d865aedbfa6598edd4375e2a5796feb0e32528793fe4cad",
"md5": "c1bd28ccdda0a26bcd7e95551f6e77ee",
"sha256": "7d9800db5503c9a16872c73e93821f51970b63f3ff3354d68b370e55aec7ab69"
},
"downloads": -1,
"filename": "dkist_processing_test-1.34.0.tar.gz",
"has_sig": false,
"md5_digest": "c1bd28ccdda0a26bcd7e95551f6e77ee",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 29898,
"upload_time": "2025-07-18T18:47:00",
"upload_time_iso_8601": "2025-07-18T18:47:00.454771Z",
"url": "https://files.pythonhosted.org/packages/95/1b/a0885dad530b4d865aedbfa6598edd4375e2a5796feb0e32528793fe4cad/dkist_processing_test-1.34.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-18 18:47:00",
"github": false,
"gitlab": false,
"bitbucket": true,
"codeberg": false,
"bitbucket_user": "dkistdc",
"bitbucket_project": "dkist-processing-test",
"lcname": "dkist-processing-test"
}
