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.

  • 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.13.2.tar.gz (33.7 kB view details)

Uploaded Source

Built Distribution

ckanext_dc_serve-0.13.2-py3-none-any.whl (37.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ckanext-dc_serve-0.13.2.tar.gz
  • Upload date:
  • Size: 33.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for ckanext-dc_serve-0.13.2.tar.gz
Algorithm Hash digest
SHA256 101fa9d521e70e218ecfaeee51dcb6960fbd949e2f7a7eea244d8c56330d7ebe
MD5 bf5518f6849431a2f47f1968e7daeef0
BLAKE2b-256 1c80e3d00c48dbdfba892719b99a9cfa8abeb963f79f157e91a8e1bebf87109c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ckanext_dc_serve-0.13.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3661394a8eed0a7485334b4babcc351cbd04097b419ee7c05c4d7a71a2bc9922
MD5 cf2d93b9d77fdadd4f87b3b770f168ab
BLAKE2b-256 1a0f4147f31e61f8f80f5be4558bdedd74833a6c092a69184ebcbb17abbf981a

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