Skip to main content

Serve DC files via GET requests on DCOR

Project description

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)

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ckanext-dc_serve-0.15.4.tar.gz (32.7 kB view details)

Uploaded Source

Built Distribution

ckanext_dc_serve-0.15.4-py3-none-any.whl (36.2 kB view details)

Uploaded Python 3

File details

Details for the file ckanext-dc_serve-0.15.4.tar.gz.

File metadata

  • Download URL: ckanext-dc_serve-0.15.4.tar.gz
  • Upload date:
  • Size: 32.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.19

File hashes

Hashes for ckanext-dc_serve-0.15.4.tar.gz
Algorithm Hash digest
SHA256 cf1faf41e2c68654973fccc748efc03e33eaf462631dfeff813ba797022a565e
MD5 0503fc3e4c3bf35e3a40dd1143c499a4
BLAKE2b-256 dba533047458ed384217d058c0452a5124feb5a9b964454697761fd48a306f8d

See more details on using hashes here.

File details

Details for the file ckanext_dc_serve-0.15.4-py3-none-any.whl.

File metadata

File hashes

Hashes for ckanext_dc_serve-0.15.4-py3-none-any.whl
Algorithm Hash digest
SHA256 a94df902f4c76920b94866bfd4b8263dd6d2ba109dee00c5cb97529c5488f5af
MD5 347f6b22d1399db3448e8e298505df75
BLAKE2b-256 fa09ab39f2017685f3ff1e80e26e2c7027970ad5ca9e8f5c0e0adfd0e65346e2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page