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/c6/eb/6f8e541cccfa37543db1dbbca5ce9190de07a901fd3304c1b66516f9e2dc/ckanext_dc_view-0.10.2.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.10.2",
"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": "a70746be6bd3832713a02de18c396fd4501877194c6ad1d7b12021ece12a96b4",
"md5": "22595bbf5b7b94364f9f450701407209",
"sha256": "9c87f187d07f383a4ab281cc86303072c7020e37ce04772bd91dcab3a3e1fdc0"
},
"downloads": -1,
"filename": "ckanext_dc_view-0.10.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "22595bbf5b7b94364f9f450701407209",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 655033,
"upload_time": "2024-08-05T10:43:35",
"upload_time_iso_8601": "2024-08-05T10:43:35.636980Z",
"url": "https://files.pythonhosted.org/packages/a7/07/46be6bd3832713a02de18c396fd4501877194c6ad1d7b12021ece12a96b4/ckanext_dc_view-0.10.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c6eb6f8e541cccfa37543db1dbbca5ce9190de07a901fd3304c1b66516f9e2dc",
"md5": "cbd067d006da73ba6b9d74e740a62c89",
"sha256": "9171977efa4e309a3e690c9c7143d269bea0637d4ce60226077a6a1be112be50"
},
"downloads": -1,
"filename": "ckanext_dc_view-0.10.2.tar.gz",
"has_sig": false,
"md5_digest": "cbd067d006da73ba6b9d74e740a62c89",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 656926,
"upload_time": "2024-08-05T10:43:37",
"upload_time_iso_8601": "2024-08-05T10:43:37.994644Z",
"url": "https://files.pythonhosted.org/packages/c6/eb/6f8e541cccfa37543db1dbbca5ce9190de07a901fd3304c1b66516f9e2dc/ckanext_dc_view-0.10.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-05 10:43:37",
"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
