Skip to main content

Python API client for performing REST calls to configurable data curation system (CDCS) databases

Project description

# Python CDCS REST API client

This is a base Python package for accessing instances of the NIST Configurable Data Curation System (CDCS) databases, versions 2.X.X and 3.X.X. It defines a Python CDCS class that streamlines REST calls to a database by

  • Taking access settings once (username, password, etc) and saving them for subsequent REST calls.

  • Defining methods that wrap around REST calls to interact with the database in a more Pythonic way.

  • Automatically converting any accessed information to pandas Series and DataFrame objects to allow for the information to be easily manipulated.

## Installation

The package can be installed using pip:

pip install cdcs

or conda:

conda install -c conda-forge cdcs

Alternatively, the source code can be downloaded from github at

## Documentation

Documentation for the package is given as Jupyter Notebooks that can be found on the github site. Each Notebook is focused on providing details and examples related to different use cases for the package.

  • CDCS Public Data Exploration outlines the basic functions allowing an anonymous user (i.e. not logged in) to explore the available public data on a curator.

  • CDCS Data Management outlines the basic pre-defined functions allowing a logged-in user to manage their own templates, data records and blobs.

  • CDCS Rest Builder provides a simple explanation of how users can easily build their own functions and make their own REST API calls should they wish to interact with the database in ways outside the pre-defined functions.

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

cdcs-0.2.6.tar.gz (24.1 kB view details)

Uploaded Source

Built Distribution

cdcs-0.2.6-py3-none-any.whl (29.5 kB view details)

Uploaded Python 3

File details

Details for the file cdcs-0.2.6.tar.gz.

File metadata

  • Download URL: cdcs-0.2.6.tar.gz
  • Upload date:
  • Size: 24.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for cdcs-0.2.6.tar.gz
Algorithm Hash digest
SHA256 23c010a3f85f5064a5680c9f505d347425d29b749acdcb505a8961204151b505
MD5 2971c95d6845c351da2108ec5a394945
BLAKE2b-256 12eb4416173d9aa45cf2665f4fa75903582201ac82ecc3cd530773996094c0e8

See more details on using hashes here.

File details

Details for the file cdcs-0.2.6-py3-none-any.whl.

File metadata

  • Download URL: cdcs-0.2.6-py3-none-any.whl
  • Upload date:
  • Size: 29.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for cdcs-0.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 4ac41d75425113c6194ce4025565a8eeb26ca2ef15b8a8405237430089160223
MD5 2aecfcc7e19fd30408f534bc7785be8d
BLAKE2b-256 127ece13bc175c347db8da40412a41e4bf2e516f83bddaf0be33e76da6e67217

See more details on using hashes here.

Supported by

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