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

Uploaded Source

Built Distribution

ckanext_dc_serve-0.13.7-py3-none-any.whl (37.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ckanext-dc_serve-0.13.7.tar.gz
  • Upload date:
  • Size: 34.0 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.7.tar.gz
Algorithm Hash digest
SHA256 b2684d00aabec205413c1aaea413a2c61b6dec809ec6d6773353f3c9c863996c
MD5 751cc9abe176ca24b80e9cc7a269396f
BLAKE2b-256 81cb8e4319ca5990cdd220d06681ed4c228a519ecbed19dc09fa11f89f7992dc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ckanext_dc_serve-0.13.7-py3-none-any.whl
Algorithm Hash digest
SHA256 085a2c6a0ffe94c3eb96f5b92baa15cae3f40044bbd706717bf50302bcac169e
MD5 216cfc395bf0001cbbbeaf6e7bac53bb
BLAKE2b-256 63f91ccc793745f2a6d3e889a3864900f0d520cc241723f5652240474abddd98

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