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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ckanext-dc_serve-0.9.3.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.3.tar.gz
Algorithm Hash digest
SHA256 e1b67388b760d708d561acdcb641412c16f6e520690ee2b0fe23c97bd45a58c2
MD5 0cd2e4d3aac4f6c680d19c4892eb5c08
BLAKE2b-256 e8f272e2473bc30b28a16fd95848c2dadd1e5d5e48d19a089a0019ace0c85f82

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ckanext_dc_serve-0.9.3-py3-none-any.whl
Algorithm Hash digest
SHA256 25e8a917fc019a4ae81547e7e7c344c2ad41f2d32474059853014cdfc89edd48
MD5 896452ac37097645c854679f0a391b31
BLAKE2b-256 253af6dbb19539f6da560581c1dbff7a201043e6971d24947750f09e177b9134

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