========
yabadaba
========
The yabadaba package (short for "Yay, a base database!") provides a mid-level
abstraction layer for interacting with databases containing JSON/XML equivalent
data records. The primary purpose of the yabadaba package is to make it easy
to design user-friendly Python packages that can access and store content in a
variety of database types.
In design, the yabadaba package consists of five major components:
1. Database classes that provide pythonic APIs to interact with databases. A
base Database class defines common method calls for interacting with the
records in a database, such as querying, adding, modifying, and deleting
entries. Child classes of Database are then defined that implement the
universal interaction methods for a given type of database.
2. A base Record class provides a template for interpreting single database
entries. Developers are meant to specify unique Record classes for each
unique schema that is part of their project. In this way, users can
interface with the data both in its raw format and using class-specific
methods and attributes. Each Record class also allows for database query
operations to be defined that allow for filtering of any hosted records
based on meaningful fields of the Record's schema.
3. A ModuleManager class is defined that helps treat the child classes of
the Database and Record classes in a modular fashion. In particular, the
ModuleManagers allow for the code to work even if there are issues with any
of the child classes, and make it possible for packages that import the
managers to append their own child classes.
4. Generic query methods are also provided that support the construction of the
record-specific query operations. In short, these are meant to allow for
queries to operate efficiently across all of the database types and ideally
return identical responses despite the underlying infrastructure
differences.
5. A Settings class is provided that makes it possible for users to save
access parameters for a database under a simple name that can then be
reloaded in a later session.
Package developers that want to provide APIs to any associated databases can
simply import the various components of yabadaba and define their own Record
classes that are specific to their own data. Users of the resulting packages
can then easily explore the data, make their own copies, etc.
Installation
------------
The yabadaba package can easily be installed using pip or conda-forge
pip install yabadaba
or
conda install -c conda-forge yabadaba
Documentation
-------------
Documentation can be found in the doc folder in the github repository.
For support, post a issue to github or email lucas.hale@nist.gov.
Raw data
{
"_id": null,
"home_page": "https://github.com/usnistgov/yabadaba",
"name": "yabadaba",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "database, mongodb, CDCS",
"author": "Lucas Hale",
"author_email": "lucas.hale@nist.gov",
"download_url": "https://files.pythonhosted.org/packages/f5/82/389ef6a00dd36588d7bd0ca835b6bc51b5bfb579e316b0a4369c533eaad6/yabadaba-0.2.2.tar.gz",
"platform": null,
"description": "========\nyabadaba\n========\n\nThe yabadaba package (short for \"Yay, a base database!\") provides a mid-level\nabstraction layer for interacting with databases containing JSON/XML equivalent\ndata records. The primary purpose of the yabadaba package is to make it easy\nto design user-friendly Python packages that can access and store content in a\nvariety of database types.\n\nIn design, the yabadaba package consists of five major components:\n\n1. Database classes that provide pythonic APIs to interact with databases. A\n base Database class defines common method calls for interacting with the \n records in a database, such as querying, adding, modifying, and deleting\n entries. Child classes of Database are then defined that implement the\n universal interaction methods for a given type of database. \n\n2. A base Record class provides a template for interpreting single database\n entries. Developers are meant to specify unique Record classes for each\n unique schema that is part of their project. In this way, users can\n interface with the data both in its raw format and using class-specific\n methods and attributes. Each Record class also allows for database query\n operations to be defined that allow for filtering of any hosted records\n based on meaningful fields of the Record's schema.\n\n3. A ModuleManager class is defined that helps treat the child classes of\n the Database and Record classes in a modular fashion. In particular, the\n ModuleManagers allow for the code to work even if there are issues with any \n of the child classes, and make it possible for packages that import the \n managers to append their own child classes.\n\n4. Generic query methods are also provided that support the construction of the\n record-specific query operations. In short, these are meant to allow for\n queries to operate efficiently across all of the database types and ideally\n return identical responses despite the underlying infrastructure\n differences.\n\n5. A Settings class is provided that makes it possible for users to save\n access parameters for a database under a simple name that can then be\n reloaded in a later session.\n\nPackage developers that want to provide APIs to any associated databases can\nsimply import the various components of yabadaba and define their own Record\nclasses that are specific to their own data. Users of the resulting packages\ncan then easily explore the data, make their own copies, etc.\n\n\nInstallation\n------------\n\nThe yabadaba package can easily be installed using pip or conda-forge\n\n pip install yabadaba\n\nor \n conda install -c conda-forge yabadaba\n\nDocumentation\n-------------\n\nDocumentation can be found in the doc folder in the github repository.\n\nFor support, post a issue to github or email lucas.hale@nist.gov.\n",
"bugtrack_url": null,
"license": null,
"summary": "Yay, a base database! An abstraction layer allowing for common interactions with Mongo, CDCS and local directory databases and records.",
"version": "0.2.2",
"project_urls": {
"Homepage": "https://github.com/usnistgov/yabadaba"
},
"split_keywords": [
"database",
" mongodb",
" cdcs"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0ea96a77b640a77fb4139c44bac7f41170e58d1a7369923e0118155e472ab45b",
"md5": "08f8bb713dcaeac7f7152996593951e9",
"sha256": "563df975282bbe890144124e21dfff8b0c3d4142e054aab3a8e9bf796cf51c53"
},
"downloads": -1,
"filename": "yabadaba-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "08f8bb713dcaeac7f7152996593951e9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 66435,
"upload_time": "2024-04-26T14:05:56",
"upload_time_iso_8601": "2024-04-26T14:05:56.886644Z",
"url": "https://files.pythonhosted.org/packages/0e/a9/6a77b640a77fb4139c44bac7f41170e58d1a7369923e0118155e472ab45b/yabadaba-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f582389ef6a00dd36588d7bd0ca835b6bc51b5bfb579e316b0a4369c533eaad6",
"md5": "794fcafd07e9a5f5e215ae9599899221",
"sha256": "f7bbe60bac4828568a0c7c93162a77248256165a06223768621bd58c8668654a"
},
"downloads": -1,
"filename": "yabadaba-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "794fcafd07e9a5f5e215ae9599899221",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 46979,
"upload_time": "2024-04-26T14:05:59",
"upload_time_iso_8601": "2024-04-26T14:05:59.546801Z",
"url": "https://files.pythonhosted.org/packages/f5/82/389ef6a00dd36588d7bd0ca835b6bc51b5bfb579e316b0a4369c533eaad6/yabadaba-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-26 14:05:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "usnistgov",
"github_project": "yabadaba",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "yabadaba"
}
JSON
