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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ckanext-dc_serve-0.9.4.tar.gz
  • Upload date:
  • Size: 28.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for ckanext-dc_serve-0.9.4.tar.gz
Algorithm Hash digest
SHA256 331d841335bdbd064cadb9122289bbea16d02c9a9b2a12f60b66b8a7bfea315b
MD5 5530db0eea0fa996323a2e1277ae7e5a
BLAKE2b-256 9175de4f8e7a0c6632f278d47cba7ffe8073874d23d49026ce5ccd66006107a9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ckanext_dc_serve-0.9.4-py3-none-any.whl
Algorithm Hash digest
SHA256 8f4df08627a95e8373ea2560a9b83781384a62cdda6be99641227c05b0aa3a3f
MD5 4e61bb8aef300651e31cb77320c7d072
BLAKE2b-256 9c05e7c9e4f2e324b5f2a8601b87206575781f9d461db2a757cb73950fdef98d

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