Metadata-Version: 2.1
Name: rdbex
Version: 0.1.1
Summary: Replit DataBase EXtended
Author: Kokonico
Author-email: kokonico@duck.com
Requires-Python: >=3.10.0,<3.11
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Requires-Dist: replit (==3.3.2)
Description-Content-Type: text/markdown

# 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

after installing the package, import using <code>import RdbEX</code>.

to create a new key in the root directory, use <code> RdbEX.create("keyname")</code>.

to delete a key, use <code> RdbEX.delete("keyname")</code>.

to create a new key within a folder, use <code> RdbEX.create("keyname", "folderA")</code>. (same thing for deleting keys within folders)

to create keys within nested folders, use <code> RdbEX.create("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>

keep in mind that by default, "|" is the spacing character for folders, this can be changed in RdbEX -> config.py

(please note that this is not full documentation, and it will be coming soon.)

(keep in mind converting databases is currently not implemented, but might happen in the future.)
