ckanext-dc_view
===============
|PyPI Version| |Build Status| |Coverage Status|
A CKAN resource view for DC data. The preview includes metadata from
the HDF5 attributes and a summary plot (scatter plot of brightness vs. area
and image, contour, mask, and fluorescence data for one event). This plugin
registers a background job for generating the overview plot after a DC
resource has been created.
This extensione implements:
- A default view for RT-DC (mimetype) resources
- A background job that generates the preview image
- A background job that uploads preview images to the S3 object store
- A route that makes the preview image available via
"/dataset/{id}/resource/{resource_id}/preview.jpg"
- CLI:
- add CKAN command `run-jobs-dc-view` that runs all background
jobs for all resources (if not already done)
Installation
------------
::
pip install ckanext-dc_view
Add this extension to the plugins and defaul_views in ckan.ini:
::
ckan.plugins = [...] dc_view
ckan.views.default_views = [...] dc_view
Testing
-------
Testing can be done via vagrant in a virtual machine using the
`dcor-test <https://app.vagrantup.com/paulmueller/boxes/dcor-test/>` image.
Make sure that `vagrant` and `virtualbox` are installed and run the
following commands in the root of this repository:
::
# Setup virtual machine using `Vagrantfile`
vagrant up
# Run the tests
vagrant ssh -- sudo bash /testing/vagrant-run-tests.sh
.. |PyPI Version| image:: https://img.shields.io/pypi/v/ckanext.dc_view.svg
:target: https://pypi.python.org/pypi/ckanext.dc_view
.. |Build Status| image:: https://img.shields.io/github/actions/workflow/status/DCOR-dev/ckanext-dc_view/check.yml
:target: https://github.com/DCOR-dev/ckanext-dc_view/actions?query=workflow%3AChecks
.. |Coverage Status| image:: https://img.shields.io/codecov/c/github/DCOR-dev/ckanext-dc_view
:target: https://codecov.io/gh/DCOR-dev/ckanext-dc_view
Raw data
{
"_id": null,
"home_page": null,
"name": "ckanext-dc-view",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": "Paul M\u00fcller <dev@craban.de>",
"keywords": "DC, DCOR, deformability, cytometry",
"author": "Paul M\u00fcller",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/f6/36/3546fdc1242a8328f2ec3ebf2d7d085345cdc70ddc33cd40b6eef176f835/ckanext_dc_view-0.11.0.tar.gz",
"platform": null,
"description": "ckanext-dc_view\n===============\n\n|PyPI Version| |Build Status| |Coverage Status|\n\nA CKAN resource view for DC data. The preview includes metadata from\nthe HDF5 attributes and a summary plot (scatter plot of brightness vs. area\nand image, contour, mask, and fluorescence data for one event). This plugin\nregisters a background job for generating the overview plot after a DC\nresource has been created.\n\nThis extensione implements:\n\n- A default view for RT-DC (mimetype) resources\n- A background job that generates the preview image\n- A background job that uploads preview images to the S3 object store\n- A route that makes the preview image available via\n \"/dataset/{id}/resource/{resource_id}/preview.jpg\"\n\n\n- CLI:\n\n - add CKAN command `run-jobs-dc-view` that runs all background\n jobs for all resources (if not already done)\n\nInstallation\n------------\n\n::\n\n pip install ckanext-dc_view\n\n\nAdd this extension to the plugins and defaul_views in ckan.ini:\n\n::\n\n ckan.plugins = [...] dc_view\n ckan.views.default_views = [...] dc_view\n\n\nTesting\n-------\nTesting can be done via vagrant in a virtual machine using the\n`dcor-test <https://app.vagrantup.com/paulmueller/boxes/dcor-test/>` image.\nMake sure that `vagrant` and `virtualbox` are installed and run the\nfollowing commands in the root of this repository:\n\n::\n\n # Setup virtual machine using `Vagrantfile`\n vagrant up\n # Run the tests\n vagrant ssh -- sudo bash /testing/vagrant-run-tests.sh\n\n\n.. |PyPI Version| image:: https://img.shields.io/pypi/v/ckanext.dc_view.svg\n :target: https://pypi.python.org/pypi/ckanext.dc_view\n.. |Build Status| image:: https://img.shields.io/github/actions/workflow/status/DCOR-dev/ckanext-dc_view/check.yml\n :target: https://github.com/DCOR-dev/ckanext-dc_view/actions?query=workflow%3AChecks\n.. |Coverage Status| image:: https://img.shields.io/codecov/c/github/DCOR-dev/ckanext-dc_view\n :target: https://codecov.io/gh/DCOR-dev/ckanext-dc_view\n",
"bugtrack_url": null,
"license": "GNU Affero General Public License v3 or later (AGPLv3+)",
"summary": "Preview DC data on DCOR",
"version": "0.11.0",
"project_urls": {
"changelog": "https://github.com/DCOR-dev/ckanext-dc_view/blob/main/CHANGELOG",
"source": "https://github.com/DCOR-dev/ckanext-dc_view",
"tracker": "https://github.com/DCOR-dev/ckanext-dc_view/issues"
},
"split_keywords": [
"dc",
" dcor",
" deformability",
" cytometry"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "28bbf60b332b2e28f25387a6bd1ad0372d4e3521ac2bf3ae8075a17b69cd483c",
"md5": "3ff866f16541bf3fb1384d100a210a26",
"sha256": "689d441edb0560f84a13b2a6d1ed477d20f52033c8123cd8a970ad6b2223cca2"
},
"downloads": -1,
"filename": "ckanext_dc_view-0.11.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3ff866f16541bf3fb1384d100a210a26",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 655061,
"upload_time": "2024-11-26T19:54:33",
"upload_time_iso_8601": "2024-11-26T19:54:33.673774Z",
"url": "https://files.pythonhosted.org/packages/28/bb/f60b332b2e28f25387a6bd1ad0372d4e3521ac2bf3ae8075a17b69cd483c/ckanext_dc_view-0.11.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f6363546fdc1242a8328f2ec3ebf2d7d085345cdc70ddc33cd40b6eef176f835",
"md5": "7fcec5ab749ea434e3133e4b00fb381c",
"sha256": "f608759daef69e69a5ecf40486ca4f31e550b131cc2cdce2380776567f3a64b0"
},
"downloads": -1,
"filename": "ckanext_dc_view-0.11.0.tar.gz",
"has_sig": false,
"md5_digest": "7fcec5ab749ea434e3133e4b00fb381c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 656956,
"upload_time": "2024-11-26T19:54:35",
"upload_time_iso_8601": "2024-11-26T19:54:35.629950Z",
"url": "https://files.pythonhosted.org/packages/f6/36/3546fdc1242a8328f2ec3ebf2d7d085345cdc70ddc33cd40b6eef176f835/ckanext_dc_view-0.11.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-26 19:54:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DCOR-dev",
"github_project": "ckanext-dc_view",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ckanext-dc-view"
}
JSON
