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

Uploaded Source

Built Distribution

ckanext_dc_serve-0.13.1-py3-none-any.whl (35.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ckanext-dc_serve-0.13.1.tar.gz
  • Upload date:
  • Size: 31.9 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.1.tar.gz
Algorithm Hash digest
SHA256 3efb3485295288eeb8b33d6e47f3de438a20fd31e6d4bf17382d703f12d8ab5c
MD5 057b1e4e6b9d62acb9a6a339af01c7d4
BLAKE2b-256 cc1dd8b67c046c4bb4965b80afcea07afc63d20367695fb4280292c114968dbe

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ckanext_dc_serve-0.13.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b30c3a35b9fc3cf013bdd74e792abec23daf07afb76c28e47efb5e969f09536f
MD5 6dbea2c378927451bf4da959aa023e46
BLAKE2b-256 f4136b311fe219398bf0fd4ae062ad09b7abf754e219ce18cf78d7e9ef914688

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