ckanext-dc_serve
================
|PyPI Version| |Build Status| |Coverage Status|
This CKAN plugin provides an API for accessing DC data. The python
package dclab implements a client library (``dclab.rtdc_dataset.fmt_dcor``)
to access this API. Shape-Out 2 offers a GUI via *File - Load DCOR data*.
This plugin implements:
- The DCOR API for accessing DC datasets online (dcserv).
- A background job that generates a condensed dataset after a resource
has been created.
- A background job that uploads the condensed dataset to the S3 object
store. The temporary location of the condensed dataset that is created
can be set by setting the ``ckanext.dc_serve.tmp_dir`` configuration
option.
- A route that makes the condensed dataset available via
"/dataset/{id}/resource/{resource_id}/condensed.rtdc"
(S3 object store data is made available via a redirect)
- A route overriding the default route for downloading a resource via
"/dataset/{id}/resource/{resource_id}/download/resource_name"
(S3 object store data is made available via a redirect)
- Extends the template to show a condensed resource download button
- CLI:
- add CKAN command ``run-jobs-dc-serve`` that runs all background
jobs for all resources (if not already done)
- Configuration keywords:
- the ``ckanext.dc_serve.create_condensed_datasets`` boolean
parameter can be set to False to prevent DCOR from generating condensed
resource files
- ``ckanext.dc_serve.enable_intra_dataset_basins`` specifies whether
intra-dataset basins should be generated or not
- ``ckanext.dc_serve.tmp_dir`` specifies the location of a directory
used for creating temporary files when condensing datasets; if not
specified, a temporary directory is used
Installation
------------
::
pip install ckanext-dc_serve
Add this extension to the plugins and defaul_views in ckan.ini:
::
ckan.plugins = [...] dc_serve
Testing
-------
Testing is implemented via GitHub Actions. You may also set up a local
docker container with CKAN and MinIO. Take a look at the GitHub Actions
workflow for more information.
.. |PyPI Version| image:: https://img.shields.io/pypi/v/ckanext.dc_serve.svg
:target: https://pypi.python.org/pypi/ckanext.dc_serve
.. |Build Status| image:: https://img.shields.io/github/actions/workflow/status/DCOR-dev/ckanext-dc_serve/check.yml
:target: https://github.com/DCOR-dev/ckanext-dc_serve/actions?query=workflow%3AChecks
.. |Coverage Status| image:: https://img.shields.io/codecov/c/github/DCOR-dev/ckanext-dc_serve
:target: https://codecov.io/gh/DCOR-dev/ckanext-dc_serve
Raw data
{
"_id": null,
"home_page": null,
"name": "ckanext-dc-serve",
"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/3e/6d/a24f826718c421a68d7191641dc16526df41d0ba7aedf602e16b628cf9ae/ckanext_dc_serve-1.0.6.tar.gz",
"platform": null,
"description": "ckanext-dc_serve\n================\n\n|PyPI Version| |Build Status| |Coverage Status|\n\nThis CKAN plugin provides an API for accessing DC data. The python\npackage dclab implements a client library (``dclab.rtdc_dataset.fmt_dcor``)\nto access this API. Shape-Out 2 offers a GUI via *File - Load DCOR data*.\n\nThis plugin implements:\n\n- The DCOR API for accessing DC datasets online (dcserv).\n- A background job that generates a condensed dataset after a resource\n has been created.\n- A background job that uploads the condensed dataset to the S3 object\n store. The temporary location of the condensed dataset that is created\n can be set by setting the ``ckanext.dc_serve.tmp_dir`` configuration\n option.\n- A route that makes the condensed dataset available via\n \"/dataset/{id}/resource/{resource_id}/condensed.rtdc\"\n (S3 object store data is made available via a redirect)\n- A route overriding the default route for downloading a resource via\n \"/dataset/{id}/resource/{resource_id}/download/resource_name\"\n (S3 object store data is made available via a redirect)\n- Extends the template to show a condensed resource download button\n\n- CLI:\n\n - add CKAN command ``run-jobs-dc-serve`` that runs all background\n jobs for all resources (if not already done)\n\n- Configuration keywords:\n\n - the ``ckanext.dc_serve.create_condensed_datasets`` boolean\n parameter can be set to False to prevent DCOR from generating condensed\n resource files\n\n - ``ckanext.dc_serve.enable_intra_dataset_basins`` specifies whether\n intra-dataset basins should be generated or not\n\n - ``ckanext.dc_serve.tmp_dir`` specifies the location of a directory\n used for creating temporary files when condensing datasets; if not\n specified, a temporary directory is used\n\n\nInstallation\n------------\n\n::\n\n pip install ckanext-dc_serve\n\n\nAdd this extension to the plugins and defaul_views in ckan.ini:\n\n::\n\n ckan.plugins = [...] dc_serve\n\n\nTesting\n-------\nTesting is implemented via GitHub Actions. You may also set up a local\ndocker container with CKAN and MinIO. Take a look at the GitHub Actions\nworkflow for more information.\n\n\n.. |PyPI Version| image:: https://img.shields.io/pypi/v/ckanext.dc_serve.svg\n :target: https://pypi.python.org/pypi/ckanext.dc_serve\n.. |Build Status| image:: https://img.shields.io/github/actions/workflow/status/DCOR-dev/ckanext-dc_serve/check.yml\n :target: https://github.com/DCOR-dev/ckanext-dc_serve/actions?query=workflow%3AChecks\n.. |Coverage Status| image:: https://img.shields.io/codecov/c/github/DCOR-dev/ckanext-dc_serve\n :target: https://codecov.io/gh/DCOR-dev/ckanext-dc_serve\n",
"bugtrack_url": null,
"license": "GNU Affero General Public License v3 or later (AGPLv3+)",
"summary": "Serve DC on DCOR data via the CKAN API interface",
"version": "1.0.6",
"project_urls": {
"changelog": "https://github.com/DCOR-dev/ckanext-dc_serve/blob/main/CHANGELOG",
"source": "https://github.com/DCOR-dev/ckanext-dc_serve",
"tracker": "https://github.com/DCOR-dev/ckanext-dc_serve/issues"
},
"split_keywords": [
"dc",
" dcor",
" deformability",
" cytometry"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "63adc877bf4d8a897c6f60bc1692ad0fbcfe028bb5637c9fd3f3e5748b91eabd",
"md5": "edd9fdecdc017c0e4b13505c83cb8ab3",
"sha256": "9206045da0e52c031f981a91519520ac22eaaec3b8239202c1617fa75744d5fc"
},
"downloads": -1,
"filename": "ckanext_dc_serve-1.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "edd9fdecdc017c0e4b13505c83cb8ab3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 755599,
"upload_time": "2025-07-12T22:49:27",
"upload_time_iso_8601": "2025-07-12T22:49:27.147968Z",
"url": "https://files.pythonhosted.org/packages/63/ad/c877bf4d8a897c6f60bc1692ad0fbcfe028bb5637c9fd3f3e5748b91eabd/ckanext_dc_serve-1.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3e6da24f826718c421a68d7191641dc16526df41d0ba7aedf602e16b628cf9ae",
"md5": "27b8d7949b97498ec54fd453574fd156",
"sha256": "e52d05bacf56df6822ddaaf86c44aa0207f61adeef378dc1dc574da426619dd3"
},
"downloads": -1,
"filename": "ckanext_dc_serve-1.0.6.tar.gz",
"has_sig": false,
"md5_digest": "27b8d7949b97498ec54fd453574fd156",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 755430,
"upload_time": "2025-07-12T22:49:28",
"upload_time_iso_8601": "2025-07-12T22:49:28.524426Z",
"url": "https://files.pythonhosted.org/packages/3e/6d/a24f826718c421a68d7191641dc16526df41d0ba7aedf602e16b628cf9ae/ckanext_dc_serve-1.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-12 22:49:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DCOR-dev",
"github_project": "ckanext-dc_serve",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ckanext-dc-serve"
}
JSON
