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. DCscope 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.
2 maintainers
Metadata
2 maintainers
Release files for ckanext-dc-serve 1.0.9
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ckanext_dc_serve-1.0.9.tar.gz | 756.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ckanext_dc_serve-1.0.9-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.5 MB
Release files / ckanext_dc_serve-1.0.9.tar.gz
| Download URL | ckanext_dc_serve-1.0.9.tar.gz |
|---|---|
| Size | 756.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
beef7058139e38d58e93ca0e808baf57c91ea35e3fb3caf105f7deba0a3b2a5c
|
|
BLAKE2b-256 checksum How to use checksums |
4982d092f0a968c5ce9e71efa6a895bad25b4ed87089a9396c5112236ee098ea
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Release files / ckanext_dc_serve-1.0.9-py3-none-any.whl
| Download URL | ckanext_dc_serve-1.0.9-py3-none-any.whl |
|---|---|
| Size | 756.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a865e2790e70cb8d2b73d755f1a17d103dc5cb03494c965737405dacd2bb35b0
|
|
BLAKE2b-256 checksum How to use checksums |
ded69909475eba73b3c8a800f6bbac3a4fc9f879e34c46d8dab77d790faeca2a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
