shadecrypt 0.1__tar.gz

shadecrypt-0.1/PKG-INFO

@@ -0,0 +1,250 @@
+Metadata-Version: 2.4
+Name: shadecrypt
+Version: 0.1
+Summary: A class oriented lightweight database with a cli wrapper for any device: store, update, copy, and remove structured data with a single command. Perfect for embedded devices, mobiles, devtools, and quick local services.
+Author: Shade
+Author-email: adesolasherifdeen3@gmail.com
+License: GPL-3.0
+Project-URL: GitHub, https://github.com/harkerbyte
+Project-URL: Facebook, https://facebook.com/harkerbyte
+Project-URL: Whatsapp, https://whatsapp.com/channel/0029Vb5f98Z90x2p6S1rhT0S
+Project-URL: Youtube, https://youtube.com/@harkerbyte
+Project-URL: Instagram, https://instagram.com/harkerbyte
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Database :: Database Engines/Servers
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license
+Dynamic: project-url
+Dynamic: requires-python
+Dynamic: summary
+
+# Shadecrypt  
+
+![PyPI - Version](https://img.shields.io/pypi/v/shadecrypt?color=blue&label=PyPI)  
+![PyPI - Downloads](https://img.shields.io/pypi/dm/shadecrypt?color=brightgreen)  
+![License](https://img.shields.io/github/license/harkerbyte/shadecrypt?color=yellow)  
+![Platform](https://img.shields.io/badge/platform-linux%20%7C%20macos%20%7C%20windows%20%7C%20android-lightgrey)  
+
+
+
+🚀 **shadeDB**, also know as **shadecrypt**, is a lightweight, multipurpose **CLI + Python database server** — small enough to run anywhere, yet powerful enough to manage structured data with speed and simplicity.  
+
+Unlike traditional file-based CLIs, Shadecrypt works more like Redis:  
+
+- You **initialize once** → a background server process holds the live database in memory.  
+- All future CLI commands (`put`, `get`, `update`, etc.) talk to that server via a local socket.  
+- The server **automatically persists** data to a `.scdb` file, with optional write and backup controls.  
+
+---
+
+## ✨ Features
+
+- **Class-oriented design** — core database logic is in the `shadeDB` class.  
+- **Persistent workflow** — one live server handles all operations.  
+- **Background persistence** — in-memory with disk persistence.  
+- **Portable** — runs on Linux, macOS, Windows, Android (via Termux).  
+- **Multipurpose CLI** — simple commands: `init`, `start`, `use`, `pull`, `get`, `update`, `remove`, `ls`, `stop`.  
+- **Config-aware** — automatically tracks the “current” DB in `~/.shadecrypt/config.scdb`.  
+
+---
+
+## 🔧 Installation
+
+```bash
+pip install shadecrypt
+```
+
+After install, the `shadecrypt` command is available globally. A shorter keyword for shadecrypt  - **scdb**
+
+---
+
+## ⚡ Quickstart (CLI)
+
+### 1. Initialize a database  
+Creates `./mydb.scdb`, starts the server, and sets it as default:  
+```bash
+shadecrypt init ./mydb.scdb backup
+```
+⚠️ Only provide the "backup" argument if you intend for the server to register newer backups as you make new changes. 
+
+---
+
+### 2. Insert data  
+```bash
+shadecrypt update alice.age 17 && scdb update alice.gender female
+```
+---
+
+### 3. Fetch data  
+```bash
+shadecrypt get alice
+# {"nickname": "Shade", "status": "active"}
+```
+---
+
+### 4. Nested access  
+```bash
+shadecrypt pull alice.nickname
+# "Shade"
+```
+
+---
+Making single value updates, it is compulsory to surround with double quotes.
+### 5. Update  
+```bash
+shadecrypt update alice "my name is alice"
+```
+
+---
+
+### 6. Remove  
+```bash
+shadecrypt remove alice 
+# deletes {"nickname":"shade","status":"active"}
+```
+### Remove nested 
+```bash
+shadecrypt remove alice.nickname
+# deletes {"nickname":"shade"} 
+````
+---
+
+### 8. Check for the current database
+```bash
+shadecrypt ls
+# ./mysql.scsb
+```
+
+---
+
+### 9. Switch database
+```bash
+shadecrypt use ./backup.scdb backup
+# Only provide the backup argument, if it need arises.
+```
+
+---
+
+### 10. Stop server  
+```bash
+shadecrypt stop
+```
+
+---
+
+## 📚 Python API  
+
+Shadecrypt can also be embedded directly into Python apps using the `ShadeDB` class.  
+
+### 🔧 Initialize  
+```python
+from shadecrypt.core import ShadeDB
+
+db = ShadeDB(
+    file="./data.scdb",
+    write=True,
+    id=True,
+    backup=False
+)
+```
+
+**Parameters**  
+- `file (str)` → Path to `.scdb` file  
+- `write (bool)` → Persist changes to disk (default: `True`)  
+- `id (bool)` → Assign unique ID per entry (default: `True`)  
+- `backup (bool)` → Keep backup copy (default: `False`)  
+
+---
+
+### 🛠️ Key Methods  
+
+```python
+db.update(("alice", {"nickname": "Shade", "status": "active"}))   # Insert/update
+db.get("alice", multiple=True/False)      # Fetch record
+db.get("alice.nickname")  # Fetch nested value
+db.get_context("alice")   # Get full dict
+db.get_by_id(1) # Fetch by ID
+db.get_id("alice",multiple=True/False) # Get ID of key
+db.items()                # List all entries
+db.import_dict({...},overwrite=True/False)     # Import dictionary, can also overwrite existing records
+db.export_dict()          # Export to dictionary
+db.remove("alice")        # Delete entry
+db.clear()                # Clear all
+db.status()               # DB status
+db.__performance__()      # Performance stats
+```
+
+---
+
+## ⚡ Example Workflow  
+
+```python
+from shadecrypt.core import ShadeDB
+
+db = ShadeDB("./appdata.scdb", write=True)
+
+# Insert
+db.update(("alice", {"nickname": "Shade", "status": "active"}))
+
+# Nested access
+print(db.get("alice.nickname"))   # Shade
+
+# Full context
+print(db.get_context("alice"))    # {'nickname': 'Shade', 'status': 'active'}
+
+# Export
+print(db.export_dict())
+```
+
+---
+
+## 📑 Command & Method Reference  
+
+| Command / Method         | Description |
+|---------------------------|-------------|
+| `init <file>  <backup>` | Initialize DB + server |
+| `use <file> <backup>`             | Switch database |
+| `pull <key>.<value>`      | Fetch nested record |
+| `get <key>`  <multiple>          | Fetch data  |
+| `update <key>.<value>`   | Update existing record |
+| `remove <key>`           | Delete entry ( Supports dot notation)|
+| `ls`                     | Current database |
+| `stop`                   | Stop server |
+| `update(item)`           | Insert/update via Python |
+| `get(key,multiple=True/False)`               | Fetch record |
+| `get_context(key)`       | Full dictionary view |
+| `get_by_id(id)`          | Fetch by unique ID |
+| `get_id(key,multiple=True/False)`            | Return ID of key |
+| `items()`                | List all entries |
+| `import_dict(dict,overwrite=True/False)`      | Import bulk dict |
+| `export_dict()`          | Export full dict |
+| `remove(key)`            | Delete by key/ID |
+| `clear()`                | Wipe database |
+| `status()`               | DB status info |
+| `__performance__()`      | Compile time & stats |
+
+
+
+### 🔮 Few hints on what's to come in future updates
+- **Remote mode** → optional TCP listener so Shadecrypt can be queried from another device (like Redis-lite networking).
+- **Replication/Sync** → lightweight push/pull sync between devices.
+- **Faster query returns** → implement a new algorithm to speed up query processing.
+- **Custom encryption algorithm** → device based encryption algorithm.
+- **Plugin system** → user-defined operations via Python modules.
+- **Connect with me** → using the links below for stunning updates.
+
+## 🌍 Connect  
+
+- **GitHub:** [harkerbyte](https://github.com/harkerbyte)  
+- **FB:** [facebook.com/harkerbyte](https://facebook.com/harkerbyte)  
+- **Instagram:** [instagram.com/harkerbyte](https://instagram.com/harkerbyte)  
+- **Community (WhatsApp):** [Join Here](https://chat.whatsapp.com/GuppqwKhp4H7OCaLWcOz40?mode=ac_t)  

shadecrypt-0.1/README.md

@@ -0,0 +1,221 @@
+# Shadecrypt  
+
+![PyPI - Version](https://img.shields.io/pypi/v/shadecrypt?color=blue&label=PyPI)  
+![PyPI - Downloads](https://img.shields.io/pypi/dm/shadecrypt?color=brightgreen)  
+![License](https://img.shields.io/github/license/harkerbyte/shadecrypt?color=yellow)  
+![Platform](https://img.shields.io/badge/platform-linux%20%7C%20macos%20%7C%20windows%20%7C%20android-lightgrey)  
+
+
+
+🚀 **shadeDB**, also know as **shadecrypt**, is a lightweight, multipurpose **CLI + Python database server** — small enough to run anywhere, yet powerful enough to manage structured data with speed and simplicity.  
+
+Unlike traditional file-based CLIs, Shadecrypt works more like Redis:  
+
+- You **initialize once** → a background server process holds the live database in memory.  
+- All future CLI commands (`put`, `get`, `update`, etc.) talk to that server via a local socket.  
+- The server **automatically persists** data to a `.scdb` file, with optional write and backup controls.  
+
+---
+
+## ✨ Features
+
+- **Class-oriented design** — core database logic is in the `shadeDB` class.  
+- **Persistent workflow** — one live server handles all operations.  
+- **Background persistence** — in-memory with disk persistence.  
+- **Portable** — runs on Linux, macOS, Windows, Android (via Termux).  
+- **Multipurpose CLI** — simple commands: `init`, `start`, `use`, `pull`, `get`, `update`, `remove`, `ls`, `stop`.  
+- **Config-aware** — automatically tracks the “current” DB in `~/.shadecrypt/config.scdb`.  
+
+---
+
+## 🔧 Installation
+
+```bash
+pip install shadecrypt
+```
+
+After install, the `shadecrypt` command is available globally. A shorter keyword for shadecrypt  - **scdb**
+
+---
+
+## ⚡ Quickstart (CLI)
+
+### 1. Initialize a database  
+Creates `./mydb.scdb`, starts the server, and sets it as default:  
+```bash
+shadecrypt init ./mydb.scdb backup
+```
+⚠️ Only provide the "backup" argument if you intend for the server to register newer backups as you make new changes. 
+
+---
+
+### 2. Insert data  
+```bash
+shadecrypt update alice.age 17 && scdb update alice.gender female
+```
+---
+
+### 3. Fetch data  
+```bash
+shadecrypt get alice
+# {"nickname": "Shade", "status": "active"}
+```
+---
+
+### 4. Nested access  
+```bash
+shadecrypt pull alice.nickname
+# "Shade"
+```
+
+---
+Making single value updates, it is compulsory to surround with double quotes.
+### 5. Update  
+```bash
+shadecrypt update alice "my name is alice"
+```
+
+---
+
+### 6. Remove  
+```bash
+shadecrypt remove alice 
+# deletes {"nickname":"shade","status":"active"}
+```
+### Remove nested 
+```bash
+shadecrypt remove alice.nickname
+# deletes {"nickname":"shade"} 
+````
+---
+
+### 8. Check for the current database
+```bash
+shadecrypt ls
+# ./mysql.scsb
+```
+
+---
+
+### 9. Switch database
+```bash
+shadecrypt use ./backup.scdb backup
+# Only provide the backup argument, if it need arises.
+```
+
+---
+
+### 10. Stop server  
+```bash
+shadecrypt stop
+```
+
+---
+
+## 📚 Python API  
+
+Shadecrypt can also be embedded directly into Python apps using the `ShadeDB` class.  
+
+### 🔧 Initialize  
+```python
+from shadecrypt.core import ShadeDB
+
+db = ShadeDB(
+    file="./data.scdb",
+    write=True,
+    id=True,
+    backup=False
+)
+```
+
+**Parameters**  
+- `file (str)` → Path to `.scdb` file  
+- `write (bool)` → Persist changes to disk (default: `True`)  
+- `id (bool)` → Assign unique ID per entry (default: `True`)  
+- `backup (bool)` → Keep backup copy (default: `False`)  
+
+---
+
+### 🛠️ Key Methods  
+
+```python
+db.update(("alice", {"nickname": "Shade", "status": "active"}))   # Insert/update
+db.get("alice", multiple=True/False)      # Fetch record
+db.get("alice.nickname")  # Fetch nested value
+db.get_context("alice")   # Get full dict
+db.get_by_id(1) # Fetch by ID
+db.get_id("alice",multiple=True/False) # Get ID of key
+db.items()                # List all entries
+db.import_dict({...},overwrite=True/False)     # Import dictionary, can also overwrite existing records
+db.export_dict()          # Export to dictionary
+db.remove("alice")        # Delete entry
+db.clear()                # Clear all
+db.status()               # DB status
+db.__performance__()      # Performance stats
+```
+
+---
+
+## ⚡ Example Workflow  
+
+```python
+from shadecrypt.core import ShadeDB
+
+db = ShadeDB("./appdata.scdb", write=True)
+
+# Insert
+db.update(("alice", {"nickname": "Shade", "status": "active"}))
+
+# Nested access
+print(db.get("alice.nickname"))   # Shade
+
+# Full context
+print(db.get_context("alice"))    # {'nickname': 'Shade', 'status': 'active'}
+
+# Export
+print(db.export_dict())
+```
+
+---
+
+## 📑 Command & Method Reference  
+
+| Command / Method         | Description |
+|---------------------------|-------------|
+| `init <file>  <backup>` | Initialize DB + server |
+| `use <file> <backup>`             | Switch database |
+| `pull <key>.<value>`      | Fetch nested record |
+| `get <key>`  <multiple>          | Fetch data  |
+| `update <key>.<value>`   | Update existing record |
+| `remove <key>`           | Delete entry ( Supports dot notation)|
+| `ls`                     | Current database |
+| `stop`                   | Stop server |
+| `update(item)`           | Insert/update via Python |
+| `get(key,multiple=True/False)`               | Fetch record |
+| `get_context(key)`       | Full dictionary view |
+| `get_by_id(id)`          | Fetch by unique ID |
+| `get_id(key,multiple=True/False)`            | Return ID of key |
+| `items()`                | List all entries |
+| `import_dict(dict,overwrite=True/False)`      | Import bulk dict |
+| `export_dict()`          | Export full dict |
+| `remove(key)`            | Delete by key/ID |
+| `clear()`                | Wipe database |
+| `status()`               | DB status info |
+| `__performance__()`      | Compile time & stats |
+
+
+
+### 🔮 Few hints on what's to come in future updates
+- **Remote mode** → optional TCP listener so Shadecrypt can be queried from another device (like Redis-lite networking).
+- **Replication/Sync** → lightweight push/pull sync between devices.
+- **Faster query returns** → implement a new algorithm to speed up query processing.
+- **Custom encryption algorithm** → device based encryption algorithm.
+- **Plugin system** → user-defined operations via Python modules.
+- **Connect with me** → using the links below for stunning updates.
+
+## 🌍 Connect  
+
+- **GitHub:** [harkerbyte](https://github.com/harkerbyte)  
+- **FB:** [facebook.com/harkerbyte](https://facebook.com/harkerbyte)  
+- **Instagram:** [instagram.com/harkerbyte](https://instagram.com/harkerbyte)  
+- **Community (WhatsApp):** [Join Here](https://chat.whatsapp.com/GuppqwKhp4H7OCaLWcOz40?mode=ac_t)  

shadecrypt-0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

shadecrypt-0.1/setup.py

@@ -0,0 +1,34 @@
+from setuptools import setup, find_packages
+
+setup(
+    name="shadecrypt",
+    version="0.1",
+    description="A class oriented lightweight database with a cli wrapper for any device: store, update, copy, and remove structured data with a single command. Perfect for embedded devices, mobiles, devtools, and quick local services.",
+    author="Shade",
+    author_email="adesolasherifdeen3@gmail.com",
+    entry_points={
+        "console_scripts": [
+          "shadecrypt=shadecrypt.cli:main",
+          "scdb=shadecrypt.cli:main"
+        ]
+    },
+    include_package_data=True,
+    python_requires='>=3.8',
+    license="GPL-3.0",
+    classifiers=[
+      "Programming Language :: Python :: 3",
+      "License :: OSI Approved :: MIT License",
+      "Environment :: Console",
+      "Intended Audience :: Developers",
+      "Topic :: Database :: Database Engines/Servers",
+    ],
+    project_urls={
+        "GitHub": "https://github.com/harkerbyte",
+        "Facebook": "https://facebook.com/harkerbyte",
+        "Whatsapp" : "https://whatsapp.com/channel/0029Vb5f98Z90x2p6S1rhT0S",
+        "Youtube" : "https://youtube.com/@harkerbyte",
+        "Instagram": "https://instagram.com/harkerbyte"
+    },
+    long_description=open("README.md", encoding="utf-8").read(),
+    long_description_content_type="text/markdown",
+)

shadecrypt-0.1/shadecrypt/__init__.py

@@ -0,0 +1,16 @@
+import os
+from shadecrypt.core import shadeDB
+
+try:
+  os.mkdir('~/.shadecrypt/',0o744)
+except Exception as error:
+  pass
+CONFIG_PATH = '~/.shadecrypt/config.scdb'
+if not os.path.exists(CONFIG_PATH):
+  with open(CONFIG_PATH,"w"):
+    pass
+  os.chmod(CONFIG_PATH,0o644)
+  instance = shadeDB(CONFIG_PATH,write=True)
+instance = shadeDB(CONFIG_PATH,write=True)
+
+