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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ckanext-dc_serve-0.13.3.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.3.tar.gz
Algorithm Hash digest
SHA256 07983ff1618210b7ba75e0f2db3eb28ca23a46dfe52290a8632550eb1d15ab15
MD5 cc1fb4a7ea47a9c52fd895e4c631b31f
BLAKE2b-256 d9de3f95e23b24e4527130938f14244e920aa02b6ffb2ed33f487897fb146d65

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ckanext_dc_serve-0.13.3-py3-none-any.whl
Algorithm Hash digest
SHA256 95e18f4c8dbac71ce756cb2dc4ee5ff976e01e38465f6a869cb74dc380e4aed7
MD5 2666f8c5c8a6e84c6c88e6785eba796f
BLAKE2b-256 291a159ab708fb917cda911189fc7136f353e060fb787b16e6d645356cf296f1

See more details on using hashes here.

Supported by

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