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.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 done via vagrant in a virtualmachine 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_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/a5/88/11758419158186bc57d10cb3ab576d6799fc1a855c5c652afdf96854572f/ckanext_dc_serve-0.17.0.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.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\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 done via vagrant in a virtualmachine 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_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": "0.17.0",
"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": "",
"digests": {
"blake2b_256": "74b3cfeff03c7c77403429f482a3e4ad28fc16fd1658931b4fd5a48596992129",
"md5": "731b19b865aac86538b6a1e3e2d224c5",
"sha256": "16f38103d109773f5e321fb134379f48e844d1ecb6180a98e09cb35795137e5a"
},
"downloads": -1,
"filename": "ckanext_dc_serve-0.17.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "731b19b865aac86538b6a1e3e2d224c5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 750459,
"upload_time": "2024-11-26T19:52:28",
"upload_time_iso_8601": "2024-11-26T19:52:28.541433Z",
"url": "https://files.pythonhosted.org/packages/74/b3/cfeff03c7c77403429f482a3e4ad28fc16fd1658931b4fd5a48596992129/ckanext_dc_serve-0.17.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a58811758419158186bc57d10cb3ab576d6799fc1a855c5c652afdf96854572f",
"md5": "b277e1d1113e455ca0e64783a35df276",
"sha256": "944d87c4cd1db7fc8a44108926c021a09fddc861bcf8c2fce7921e9f68522a2d"
},
"downloads": -1,
"filename": "ckanext_dc_serve-0.17.0.tar.gz",
"has_sig": false,
"md5_digest": "b277e1d1113e455ca0e64783a35df276",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 749841,
"upload_time": "2024-11-26T19:52:31",
"upload_time_iso_8601": "2024-11-26T19:52:31.698047Z",
"url": "https://files.pythonhosted.org/packages/a5/88/11758419158186bc57d10cb3ab576d6799fc1a855c5c652afdf96854572f/ckanext_dc_serve-0.17.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-26 19:52:31",
"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
