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.

  • A background job that generates a condensed dataset after a resource has been created.

  • A route that makes the condensed dataset available via “/dataset/{id}/resource/{resource_id}/condensed.rtdc”

  • 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

If CKAN/DCOR is installed and setup for testing, this extension can be tested with pytest:

pytest ckanext

Testing can also be 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.9.5.tar.gz (28.3 kB view details)

Uploaded Source

Built Distribution

ckanext_dc_serve-0.9.5-py3-none-any.whl (30.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ckanext-dc_serve-0.9.5.tar.gz
Algorithm Hash digest
SHA256 c9e5f0589c5b89418bac3ad84b1a5a97c545fd3c201aa072abe53b2ba0e51521
MD5 0634906776518354cbac5de93404f298
BLAKE2b-256 fdf1a13147acdffced969cdb04865379b686343be9353b05279ab9c0f6c8d88b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ckanext_dc_serve-0.9.5-py3-none-any.whl
Algorithm Hash digest
SHA256 f6b314286969476c5ce6bdcbe1d1de7a0dc0e3c62dca91d1ea5101f037f67a27
MD5 2d8ed914d803e60ac8de920eeb776f65
BLAKE2b-256 00b42c3e96e7b7c3f8162afe2ba9ddae472591211d41ea665cfe813a585b161b

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