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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ckanext-dc_serve-0.13.10.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.10.tar.gz
Algorithm Hash digest
SHA256 b55874138f52630854387cb79c2501272db7bee2debb5d2420379d252aa080ac
MD5 900c0a7ad0b3a4c33aedf78984beeefb
BLAKE2b-256 70136734b4dc9b23e78ef2083b2d4a40d8301055e3ca6c3f5d46d9382943322c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ckanext_dc_serve-0.13.10-py3-none-any.whl
Algorithm Hash digest
SHA256 43bbaf0d24639d24c2b7e90ad16962148387e4db1842292343dd3f303b6cd012
MD5 9c99c9b5df19fcbcb881a8c00a9f21f2
BLAKE2b-256 115e75accd4e3bb68be5d0188fb5279272af8ae0caa69f839947836efcbcc8dd

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