paperbase 2.0

Simple file-based database with user auth

PaperBase

PaperBase is a lightweight, file-based, plug-and-play database engine designed for quick data storage using native Python and optional C++ authentication handling.

It is perfect for small projects, prototyping, or when you need a no-server, local-first database structure.

---

🔧 Features

• File-system-based hierarchical database
• Insert, retrieve, edit, and delete key-value data
• User authentication using hashed passwords (with C++ auth handler)
• Easy project switching with connect()
• Modular access via auth, config, and pdb

---

🚀 Installation

pip install paperbase

🧠 Usage

from paperbase import config
from paperbase import auth
from paperbase import pdb

# === CONFIG MODULE ===

# Create a new project (prints its UID)
config.createNewProject("TestProject")

# Optional: List all available projects
config.listProjects()

# Optional: Delete a project by name
# config.deleteProject("TestProject")

# Connect to a project by UID (from printed createNewProject())
config.connect("YOUR_KEY")


# === AUTH MODULE ===

# Create a new user
auth.createUser("[e-mail]", "password123")

# Sign in an existing user
auth.signInUser("[e-mail]", "password123")

# Delete a user
# auth.deleteUser("[e-mail]")


# === PDB MODULE (DATABASE) ===

# Create a new PaperBase called "Users"
pdb.newPaperBase("Users")

# Create subbases (e.g., per user/email)
pdb.newPaperSubBase("Users", "[e-mail]")
pdb.newPaperSubBase("Users", "[e-mail]")

# Insert data into subbases
pdb.insertData("Users", subpath="[e-mail]", key="Name", value="Aritra")
pdb.insertData("Users", subpath="[e-mail]", key="Name", value="Paper")
pdb.insertData("Users", subpath="[e-mail]", key="Role", value="Admin")

# Retrieve specific data
data = pdb.retrieveData("Users", "Name", subpath="[e-mail]")
print("Retrieved Name for Aritra:", data)

# Edit existing data
pdb.editData("Users", subpath="[e-mail]", key="Role", new_value="SuperAdmin")

# Retrieve again to verify edit
updated_role = pdb.retrieveData("Users", "Role", subpath="[e-mail]")
print("Updated Role for Aritra:", updated_role)

# Retrieve all subbases under "Users"
subbases = pdb.retrieveSubBases("Users")
print("All subbases under 'Users':", subbases)

# Retrieve all key-values in a subbase
all_data = pdb.retrieveSubBaseDatas("Users", "[e-mail]")
print("All data in Aritra's subbase:", all_data)

# Delete specific data field
pdb.deleteData("Users", subpath="[e-mail]", key="Name")

# Delete a subbase
pdb.deletePaperSubBase("Users", "[e-mail]")

# Delete entire PaperBase
# pdb.deletePaperBase("Users")

---

📃 License

This project is licensed under the MIT License.

LICENSE (MIT License)

MIT License

Copyright (c) 2025 YOUR_NAME

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the “Software”), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.