| Name | RdbEX JSON |
| Version |
0.2.4
JSON |
| download |
| home_page | |
| Summary | Replit DataBase EXtended |
| upload_time | 2023-10-14 01:07:08 |
| maintainer | |
| docs_url | None |
| author | Kokonico |
| requires_python | >=3.10.0,<3.12 |
| license | |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# RdbEX
## Replit DataBase EXtended
Replit database extended is a package designed to expand the abilities of the default replit database.
it adds things such as:
<br>
**emulated folders**
<br>
**ease of access**
<br>
**value sharing**
<br>
**safe secret storage**
<br>
*and much more...*
## how to use: a basic rundown
### (NOTE: does NOT support versions below 0.2)
after installing the package, import using <code>import rdbex</code>.
to create a new key in the root directory, use <code> rdbex.set("keyname")</code>.
to delete a key, use <code> rdbex.delete("keyname")</code>.
to create a new key within a folder, use <code> rdbex.set("keyname", "folderA")</code>. (same thing for deleting keys within folders)
to create keys within nested folders, use <code> rdbex.set("keyname", "folderA|folderB")</code>. (same thing for deleting keys within folders)
to list keys and list keys within a folder(s), use <code> rdbex.list("folderA|folderB (optional)")</code>.
and to drop your database (with an optional path), use <code> rdbex.drop("folderpath (optional)")</code>
### key sharing
to share a key with another value, use <code>rdbex.reference("FROM", "key", "path (optional)"</code> in the <code>value</code> section of <code>rdbex.set()</code>
### secret storage
to safely store replit secrets and os environment variables within your database, use <code>rdbex.reference("ENV", "variable name")</code> in the <code>value</code> section of <code>rdbex.set()</code>
## Recovery.
### warning!
to repair anything without reinstalling the package, you need to make sure the "recovery.py" and "__internal/_recovery.py" files are accessible.
<br>
<br>
if you delete a required file from the package or the package gets corrupted and if fails to load on import, you will get an ImportError that says *"The package has been installed incorrectly and/or has been corrupted. please reinstall the package."*, to fix this, just uninstall & reinstall the package using the package manager of your choice.
if the database is corrupted, you will get an ImportError saying *"critical damage to rdbex detected. a repair has been ran, please restart. if the error persists, use "from rdbex import recovery" and run recovery.rebuild() to attempt to fix the issue"*, before doing anything, try rerunning the code, as it attempts to repair the database. if the error still persists, run <code>from rdbex import recovery</code>. after importing recovery, run <code>recovery.rebuild()</code> to completely rebuild the database metadata.
<br>
***this WILL wipe ALL user-set config, but NOT the db***
<br>
<br>
<br>
<sub>*keep in mind that by default, "|" is the spacing character for folders, this can be changed via the <code>configure()</code> command in utils*
<sub>*this is not full documentation, and it will be coming soon.*
<sub>*converting databases is currently not implemented, but might happen in the future.*
Raw data
{
"_id": null,
"home_page": "",
"name": "RdbEX",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10.0,<3.12",
"maintainer_email": "",
"keywords": "",
"author": "Kokonico",
"author_email": "kokonico@duck.com",
"download_url": "https://files.pythonhosted.org/packages/33/f7/5e2ddd0aabd8681a885a872087386e6cb83c242f4ef4e46f44d66cd53bfe/rdbex-0.2.4.tar.gz",
"platform": null,
"description": "# RdbEX\n## Replit DataBase EXtended\n\nReplit database extended is a package designed to expand the abilities of the default replit database.\n\nit adds things such as:\n<br>\n**emulated folders**\n<br>\n**ease of access**\n<br>\n**value sharing**\n<br>\n**safe secret storage**\n<br>\n*and much more...*\n\n## how to use: a basic rundown\n\n### (NOTE: does NOT support versions below 0.2)\n\nafter installing the package, import using <code>import rdbex</code>.\n\nto create a new key in the root directory, use <code> rdbex.set(\"keyname\")</code>.\n\nto delete a key, use <code> rdbex.delete(\"keyname\")</code>.\n\nto create a new key within a folder, use <code> rdbex.set(\"keyname\", \"folderA\")</code>. (same thing for deleting keys within folders)\n\nto create keys within nested folders, use <code> rdbex.set(\"keyname\", \"folderA|folderB\")</code>. (same thing for deleting keys within folders)\n\nto list keys and list keys within a folder(s), use <code> rdbex.list(\"folderA|folderB (optional)\")</code>.\n\nand to drop your database (with an optional path), use <code> rdbex.drop(\"folderpath (optional)\")</code>\n\n### key sharing\n\nto share a key with another value, use <code>rdbex.reference(\"FROM\", \"key\", \"path (optional)\"</code> in the <code>value</code> section of <code>rdbex.set()</code>\n\n### secret storage\n\nto safely store replit secrets and os environment variables within your database, use <code>rdbex.reference(\"ENV\", \"variable name\")</code> in the <code>value</code> section of <code>rdbex.set()</code>\n\n## Recovery.\n\n### warning!\n\nto repair anything without reinstalling the package, you need to make sure the \"recovery.py\" and \"__internal/_recovery.py\" files are accessible.\n<br>\n<br>\nif you delete a required file from the package or the package gets corrupted and if fails to load on import, you will get an ImportError that says *\"The package has been installed incorrectly and/or has been corrupted. please reinstall the package.\"*, to fix this, just uninstall & reinstall the package using the package manager of your choice.\n\nif the database is corrupted, you will get an ImportError saying *\"critical damage to rdbex detected. a repair has been ran, please restart. if the error persists, use \"from rdbex import recovery\" and run recovery.rebuild() to attempt to fix the issue\"*, before doing anything, try rerunning the code, as it attempts to repair the database. if the error still persists, run <code>from rdbex import recovery</code>. after importing recovery, run <code>recovery.rebuild()</code> to completely rebuild the database metadata. \n<br>\n***this WILL wipe ALL user-set config, but NOT the db***\n\n<br>\n<br>\n<br>\n<sub>*keep in mind that by default, \"|\" is the spacing character for folders, this can be changed via the <code>configure()</code> command in utils*\n\n<sub>*this is not full documentation, and it will be coming soon.*\n\n<sub>*converting databases is currently not implemented, but might happen in the future.*",
"bugtrack_url": null,
"license": "",
"summary": "Replit DataBase EXtended",
"version": "0.2.4",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d73904afaf213f218037fad331c4d8a60740e97a691dfeb8655866f6c96e37e7",
"md5": "c949721d7bc4eba10e79f366963c3856",
"sha256": "eac8abd2259221e8f173e01863e66a5a17782233571fff5a02a0462286bd1c16"
},
"downloads": -1,
"filename": "rdbex-0.2.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c949721d7bc4eba10e79f366963c3856",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10.0,<3.12",
"size": 6946,
"upload_time": "2023-10-14T01:07:07",
"upload_time_iso_8601": "2023-10-14T01:07:07.337253Z",
"url": "https://files.pythonhosted.org/packages/d7/39/04afaf213f218037fad331c4d8a60740e97a691dfeb8655866f6c96e37e7/rdbex-0.2.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "33f75e2ddd0aabd8681a885a872087386e6cb83c242f4ef4e46f44d66cd53bfe",
"md5": "f14bd27a7bf65a0f22d849c0c185487a",
"sha256": "101d2048f3542a78671d92242826fa30774f5af9994cc2459c984f3f842d5079"
},
"downloads": -1,
"filename": "rdbex-0.2.4.tar.gz",
"has_sig": false,
"md5_digest": "f14bd27a7bf65a0f22d849c0c185487a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10.0,<3.12",
"size": 4972,
"upload_time": "2023-10-14T01:07:08",
"upload_time_iso_8601": "2023-10-14T01:07:08.398398Z",
"url": "https://files.pythonhosted.org/packages/33/f7/5e2ddd0aabd8681a885a872087386e6cb83c242f4ef4e46f44d66cd53bfe/rdbex-0.2.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-14 01:07:08",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "rdbex"
}
