# 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
- Stable releases: [https://github.com/usnistgov/pycdcs](https://github.com/usnistgov/pycdcs)
- In development: [https://github.com/lmhale99/pycdcs](https://github.com/lmhale99/pycdcs)
## 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/usnistgov/pycdcs",
"name": "cdcs",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "CDCS, database, rest API, configurable data curation system",
"author": "Lucas Hale",
"author_email": "lucas.hale@nist.gov",
"download_url": "https://files.pythonhosted.org/packages/dc/bd/47ac823f4b897b5c6cedf74b2c2c2c03474e143a7f10d8551a7994300d91/cdcs-0.2.3.tar.gz",
"platform": null,
"description": "# Python CDCS REST API client\n\nThis 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\n\n- Taking access settings once (username, password, etc) and saving them for subsequent REST calls.\n- Defining methods that wrap around REST calls to interact with the database in a more Pythonic way.\n- Automatically converting any accessed information to pandas Series and DataFrame objects to allow for the information to be easily manipulated.\n\n## Installation\n\nThe package can be installed using pip:\n\n pip install cdcs\n\nor conda:\n\n conda install -c conda-forge cdcs\n\nAlternatively, the source code can be downloaded from github at\n\n- Stable releases: [https://github.com/usnistgov/pycdcs](https://github.com/usnistgov/pycdcs)\n- In development: [https://github.com/lmhale99/pycdcs](https://github.com/lmhale99/pycdcs)\n\n## Documentation\n\nDocumentation 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.\n\n- **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.\n- **CDCS Data Management** outlines the basic pre-defined functions allowing a logged-in user to manage their own templates, data records and blobs.\n- **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.\n",
"bugtrack_url": null,
"license": null,
"summary": "Python API client for performing REST calls to configurable data curation system (CDCS) databases",
"version": "0.2.3",
"project_urls": {
"Homepage": "https://github.com/usnistgov/pycdcs"
},
"split_keywords": [
"cdcs",
" database",
" rest api",
" configurable data curation system"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "66c4263484b39d76b0b41f2d3786b1d339d5e1a4ca75159375b784382581a6cc",
"md5": "b7ee9e0fa6619e6fa20791a244bf74e1",
"sha256": "40fd386506c48a585b9597d5c55d5e965b2e48869dbfdf47ab7ab3f3f578daa4"
},
"downloads": -1,
"filename": "cdcs-0.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b7ee9e0fa6619e6fa20791a244bf74e1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 28451,
"upload_time": "2024-04-25T19:38:08",
"upload_time_iso_8601": "2024-04-25T19:38:08.587244Z",
"url": "https://files.pythonhosted.org/packages/66/c4/263484b39d76b0b41f2d3786b1d339d5e1a4ca75159375b784382581a6cc/cdcs-0.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dcbd47ac823f4b897b5c6cedf74b2c2c2c03474e143a7f10d8551a7994300d91",
"md5": "fcd950ad19afdfd1ba37b6c217a6d695",
"sha256": "b040ed1b7133072e7a78b6bb8c3443f5316095de974ed9456cacc0c9b6578bd7"
},
"downloads": -1,
"filename": "cdcs-0.2.3.tar.gz",
"has_sig": false,
"md5_digest": "fcd950ad19afdfd1ba37b6c217a6d695",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 22975,
"upload_time": "2024-04-25T19:38:09",
"upload_time_iso_8601": "2024-04-25T19:38:09.688603Z",
"url": "https://files.pythonhosted.org/packages/dc/bd/47ac823f4b897b5c6cedf74b2c2c2c03474e143a7f10d8551a7994300d91/cdcs-0.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-25 19:38:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "usnistgov",
"github_project": "pycdcs",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "cdcs"
}
JSON
