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”

  • 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.6.0.tar.gz (23.8 kB view details)

Uploaded Source

Built Distribution

ckanext_dc_serve-0.6.0-py3-none-any.whl (25.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ckanext-dc_serve-0.6.0.tar.gz
  • Upload date:
  • Size: 23.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for ckanext-dc_serve-0.6.0.tar.gz
Algorithm Hash digest
SHA256 3bd6db22a6fe64768b06b9cf29e3832f12938bbf6dbab772956f3c10e66ca8ba
MD5 23ab62beaeefc61d172c03deb71a4f1a
BLAKE2b-256 7b0ec4ea85855103499374e2b45ac14a033e2f82ba968770c2dfdaff423c5ef3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ckanext_dc_serve-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 25.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for ckanext_dc_serve-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 202ac38d2654bc91c9d9bbb5aed29238c495dbea0997b5507499570b4f5b2264
MD5 c7d2cf51956eca1dd8f0e4003cece8ce
BLAKE2b-256 6c97135c9ae90b046867a7c96db7bf135dfdf08953d3314b16dd54a6d8ebd265

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