Skip to main content

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. 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.

Metadata

Release files for ckanext-dc-serve 1.0.10

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ckanext-dc-serve 1.0.10
File Size Uploaded Provenance Actions
ckanext_dc_serve-1.0.10.tar.gz 757.0 kB Without provenance Details for ckanext_dc_serve-1.0.10.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ckanext-dc-serve 1.0.10
File Interpreter ABI Platform Actions
ckanext_dc_serve-1.0.10-py3-none-any.whl Python 3 none any Details for ckanext_dc_serve-1.0.10-py3-none-any.whl

Total release size: 1.5 MB

Release files / ckanext_dc_serve-1.0.10.tar.gz

Download URL ckanext_dc_serve-1.0.10.tar.gz
Size 757.0 kB
Tags Source
SHA-256 checksum
How to use checksums
46450d0b55ac808c448a45a768f3714d415b61e8291bed5beedfe6ea8817b0a0
BLAKE2b-256 checksum
How to use checksums
87ec32739d743097e05fabc1199fbf4a153411d6ca39016d99efc41d92efdbbc
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.10-py3-none-any.whl

Download URL ckanext_dc_serve-1.0.10-py3-none-any.whl
Size 756.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c21b32649ed310da98b6967a3351d6cd546c39305b9dfa5369afb1ee48925e87
BLAKE2b-256 checksum
How to use checksums
3547447f8ecbefba4b3218a9a510f3ecb2aa0ec651a725b9d337c2d8575047ce
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Security for ckanext-dc-serve 1.0.10

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.10 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page