pybasedb-json 0.2.0__tar.gz → 0.4.0__tar.gz

pybasedb_json-0.4.0/PKG-INFO

@@ -0,0 +1,146 @@
+Metadata-Version: 2.4
+Name: pybasedb-json
+Version: 0.4.0
+Summary: Banco de dados local com JSON — schemas, decorator API, server REST, criptografia, zero dependencias
+Author-email: Marcos Gomes <marcosgabrielgomes110@gmail.com>
+Maintainer-email: Marcos Gomes <marcosgabrielgomes110@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/marcosgabrielgomes110-collab/Pybase
+Project-URL: Documentation, https://github.com/marcosgabrielgomes110-collab/Pybase/tree/main/docs
+Project-URL: Repository, https://github.com/marcosgabrielgomes110-collab/Pybase
+Keywords: database,json,local,embedded,nosql,thread-safe,rest-api,schema,media
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="assets/logo/logo.png" width="120" alt="Pybase logo">
+</p>
+
+# Pybase v0.4
+
+Base para criacao de bancos de dados locais com JSON. Zero dependencias, 100% stdlib.
+Operacoes de escrita atomicas, thread-safe.
+
+Filosofia **Lego**: cada modulo e independente — voce monta o que precisa.
+
+## Instalacao
+
+```bash
+pip install pybasedb-json
+```
+
+Para o servidor REST (opcional):
+```bash
+pip install Flask
+```
+
+## Uso rapido
+
+```python
+from pybase import pybase as pb
+
+# Banco de dados (sem senha ou com senha)
+db = pb.Database("./data/mydb")
+# db = pb.Database("./data/mydb", password="senha").open("senha")
+
+# Schema com decorator (v0.4+)
+@db.schema.users
+class User:
+    name: str
+    email: str
+    age: int = 0
+    active: bool = True
+
+# Ou com T() explicito
+# from pybase.validation import T
+# db.schema.users = pb.Schema({"name": pb.T(str), "age": pb.T(int, default=0)})
+
+# Colecao com validacao automatica
+users = db["users"]
+users.add({"name": "marcos", "email": "m@m.com"})  # auto-ID
+
+# SDK client
+doc = users["1"].get()
+users.find(age=0)
+
+# Consultas direto na colecao (v0.4+)
+users.sort("name").limit(10).find(active=True)
+users.find_one(name="ana")
+users.exists(name="joao")
+
+# Servidor REST (requer Flask)
+pb.Server(db).run(port=4560)  # auto-detecta colecoes
+# Swagger UI: http://localhost:4560/mydb/docs/
+```
+
+## Modulos
+
+| Modulo | Arquivo | Descricao | Deps |
+|--------|---------|-----------|------|
+| Database | `pybase/database.py` | Gerencia diretorio de tabelas JSON | 0 |
+| Collection | `pybase/collections.py` | CRUD atomico thread-safe + query integrado | 0 |
+| Query | `pybase/query.py` | Thin wrapper sobre Collection | 0 |
+| Schema | `pybase/validation.py` | Validacao com T(), decorator, from_example | 0 |
+| Server | `pybase/server.py` | REST API automatica + Swagger UI | Flask |
+| Media | `pybase/media.py` | Upload/download de imagens | 0 |
+| Backup | `pybase/backup.py` | Snapshot e restore (seletivo) | 0 |
+| Crypto | `pybase/crypto.py` | Criptografia stdlib (scrypt + XOR) | 0 |
+
+## Novidades da v0.4
+
+- **API simplificada** — `Database("./data/mydb")` sem senha obrigatoria
+- **`update`/`delete`** — nomes em ingles, sem aliases pt-br
+- **Auto-ID** — `users.add({"name": "x"})` gera UUID automatico
+- **`db["colecao"]`** — acesso direto via `__getitem__`
+- **Query integrado** — `collection.sort().limit().find()` direto
+- **`@db.schema.nome`** — schema via decorator de classe
+- **`T()`** — nova API de tipos com kwargs (`T(int, default=0)`)
+- **`Schema.from_example()`** — schema inferido de dados reais
+- **`import global`** — `from pybase import pybase`
+- **PBKDF2** — hashing de senha com salt (600k iteracoes)
+- **Criptografia** — `encrypt()`/`decrypt()` stdlib puro
+- **Server auto-detect** — `Server(db).run()` descobre colecoes
+- **Erros descritivos** — com path + valor + sugestao
+
+## Estrutura
+
+```
+Pybase/
+  pybase/
+    __init__.py       # Database, Collection, Query, Server, Schema, T
+    pybase.py         # from pybase import pybase
+    database.py       # Database, SchemaRegistrar
+    collections.py    # Collection, DocRef, QueryBuilder, SchemaCollection
+    query.py          # Query wrapper
+    exceptions.py     # PybaseError > DatabaseError, CollectionError, ...
+    validation.py     # Schema, T, ValidationError
+    server.py         # Server REST (Flask)
+    media.py          # MediaManager
+    index.py          # Index (hash O(1))
+    hooks.py          # HooksCollection
+    backup.py         # take, restore
+    crypto.py         # encrypt, decrypt (stdlib)
+    utils.py          # PBKDF2 encode/verify
+  docs/               # Documentacao completa
+  pyproject.toml
+```
+
+## Documentacao
+
+Veja [docs/](docs/index.md) com referencia completa de cada classe e metodo.
+
+## Licenca
+
+MIT

pybasedb_json-0.4.0/README.md

@@ -0,0 +1,120 @@
+<p align="center">
+  <img src="assets/logo/logo.png" width="120" alt="Pybase logo">
+</p>
+
+# Pybase v0.4
+
+Base para criacao de bancos de dados locais com JSON. Zero dependencias, 100% stdlib.
+Operacoes de escrita atomicas, thread-safe.
+
+Filosofia **Lego**: cada modulo e independente — voce monta o que precisa.
+
+## Instalacao
+
+```bash
+pip install pybasedb-json
+```
+
+Para o servidor REST (opcional):
+```bash
+pip install Flask
+```
+
+## Uso rapido
+
+```python
+from pybase import pybase as pb
+
+# Banco de dados (sem senha ou com senha)
+db = pb.Database("./data/mydb")
+# db = pb.Database("./data/mydb", password="senha").open("senha")
+
+# Schema com decorator (v0.4+)
+@db.schema.users
+class User:
+    name: str
+    email: str
+    age: int = 0
+    active: bool = True
+
+# Ou com T() explicito
+# from pybase.validation import T
+# db.schema.users = pb.Schema({"name": pb.T(str), "age": pb.T(int, default=0)})
+
+# Colecao com validacao automatica
+users = db["users"]
+users.add({"name": "marcos", "email": "m@m.com"})  # auto-ID
+
+# SDK client
+doc = users["1"].get()
+users.find(age=0)
+
+# Consultas direto na colecao (v0.4+)
+users.sort("name").limit(10).find(active=True)
+users.find_one(name="ana")
+users.exists(name="joao")
+
+# Servidor REST (requer Flask)
+pb.Server(db).run(port=4560)  # auto-detecta colecoes
+# Swagger UI: http://localhost:4560/mydb/docs/
+```
+
+## Modulos
+
+| Modulo | Arquivo | Descricao | Deps |
+|--------|---------|-----------|------|
+| Database | `pybase/database.py` | Gerencia diretorio de tabelas JSON | 0 |
+| Collection | `pybase/collections.py` | CRUD atomico thread-safe + query integrado | 0 |
+| Query | `pybase/query.py` | Thin wrapper sobre Collection | 0 |
+| Schema | `pybase/validation.py` | Validacao com T(), decorator, from_example | 0 |
+| Server | `pybase/server.py` | REST API automatica + Swagger UI | Flask |
+| Media | `pybase/media.py` | Upload/download de imagens | 0 |
+| Backup | `pybase/backup.py` | Snapshot e restore (seletivo) | 0 |
+| Crypto | `pybase/crypto.py` | Criptografia stdlib (scrypt + XOR) | 0 |
+
+## Novidades da v0.4
+
+- **API simplificada** — `Database("./data/mydb")` sem senha obrigatoria
+- **`update`/`delete`** — nomes em ingles, sem aliases pt-br
+- **Auto-ID** — `users.add({"name": "x"})` gera UUID automatico
+- **`db["colecao"]`** — acesso direto via `__getitem__`
+- **Query integrado** — `collection.sort().limit().find()` direto
+- **`@db.schema.nome`** — schema via decorator de classe
+- **`T()`** — nova API de tipos com kwargs (`T(int, default=0)`)
+- **`Schema.from_example()`** — schema inferido de dados reais
+- **`import global`** — `from pybase import pybase`
+- **PBKDF2** — hashing de senha com salt (600k iteracoes)
+- **Criptografia** — `encrypt()`/`decrypt()` stdlib puro
+- **Server auto-detect** — `Server(db).run()` descobre colecoes
+- **Erros descritivos** — com path + valor + sugestao
+
+## Estrutura
+
+```
+Pybase/
+  pybase/
+    __init__.py       # Database, Collection, Query, Server, Schema, T
+    pybase.py         # from pybase import pybase
+    database.py       # Database, SchemaRegistrar
+    collections.py    # Collection, DocRef, QueryBuilder, SchemaCollection
+    query.py          # Query wrapper
+    exceptions.py     # PybaseError > DatabaseError, CollectionError, ...
+    validation.py     # Schema, T, ValidationError
+    server.py         # Server REST (Flask)
+    media.py          # MediaManager
+    index.py          # Index (hash O(1))
+    hooks.py          # HooksCollection
+    backup.py         # take, restore
+    crypto.py         # encrypt, decrypt (stdlib)
+    utils.py          # PBKDF2 encode/verify
+  docs/               # Documentacao completa
+  pyproject.toml
+```
+
+## Documentacao
+
+Veja [docs/](docs/index.md) com referencia completa de cada classe e metodo.
+
+## Licenca
+
+MIT

pybasedb_json-0.4.0/pybase/__init__.py

@@ -0,0 +1,44 @@
+try:
+    from .server import Server
+except ImportError:
+    Server = None
+
+from .collections import Collection, DocRef, QueryBuilder, SchemaCollection
+from .database import Database
+from .exceptions import (
+    CollectionError,
+    DatabaseError,
+    DocumentNotFoundError,
+    EncryptionError,
+    MediaError,
+    PybaseError,
+    QueryError,
+    ValidationError,
+)
+from .query import Query
+
+try:
+    from .validation import Schema, T
+except ImportError:
+    Schema = None
+    T = None
+
+__all__ = [
+    "Collection",
+    "Database",
+    "DocRef",
+    "DocumentNotFoundError",
+    "EncryptionError",
+    "MediaError",
+    "PybaseError",
+    "DatabaseError",
+    "CollectionError",
+    "Query",
+    "QueryBuilder",
+    "QueryError",
+    "Schema",
+    "SchemaCollection",
+    "Server",
+    "T",
+    "ValidationError",
+]

pybasedb_json-0.4.0/pybase/backup.py

@@ -0,0 +1,100 @@
+# Lego piece: optional backup / restore for Pybase databases.
+#   from pybase.backup import take, restore, list_snapshots
+#   snap = take(db)  # timestamped .json.gz
+
+from __future__ import annotations
+
+import gzip
+import json
+import os
+from datetime import datetime
+from pathlib import Path
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from .database import Database
+
+_BACKUP_DIR = "backups"
+
+
+def take(
+    db: Database,
+    dest: str | Path | None = None,
+    *,
+    compress: bool = True,
+    collections: list[str] | None = None,
+) -> Path:
+    backup_dir = Path(dest) if dest else (db.path_dir / _BACKUP_DIR)
+    backup_dir.mkdir(parents=True, exist_ok=True)
+
+    ts = datetime.now().strftime("%Y%m%d_%H%M%S")
+    ext = ".json.gz" if compress else ".json"
+    out_path = backup_dir / f"{db.name}_{ts}{ext}"
+
+    names = collections if collections else db.collections
+    snapshot: dict[str, list[dict]] = {}
+    for name in names:
+        snapshot[name] = db.collection(name).all()
+
+    raw = json.dumps(snapshot, indent=2).encode("utf-8")
+
+    if compress:
+        # mtime=0 makes the gzip deterministic (same content → same bytes)
+        with gzip.GzipFile(out_path, "wb", mtime=0) as f:
+            f.write(raw)
+    else:
+        out_path.write_bytes(raw)
+
+    return out_path
+
+
+def restore(
+    db_dir: str | Path,
+    snapshot: str | Path,
+    *,
+    merge: bool = False,
+) -> None:
+    # Restore collection data from a snapshot file (.json or .json.gz)
+    db_dir = Path(db_dir)
+    snap_path = Path(snapshot)
+
+    if snap_path.suffix == ".gz":
+        with gzip.GzipFile(snap_path, "rb") as f:
+            raw = f.read()
+    else:
+        raw = snap_path.read_bytes()
+
+    data: dict[str, list[dict]] = json.loads(raw)
+
+    for name, docs in data.items():
+        col_path = db_dir / f"{name}_table.json"
+        existing = []
+        if merge and col_path.exists():
+            existing = (json.loads(col_path.read_bytes()) if col_path.stat().st_size else [])
+        merged = existing + docs if merge else docs
+
+        # atomic write
+        tmp = col_path.with_suffix(".tmp")
+        tmp.write_text(json.dumps(merged, indent=2), encoding="utf-8")
+        os.replace(tmp, col_path)
+
+
+def list_snapshots(backup_dir: str | Path) -> list[Path]:
+    # Return snapshots sorted newest first
+    d = Path(backup_dir)
+    if not d.exists():
+        return []
+    files = sorted(p for p in d.iterdir() if p.suffix in (".json", ".gz") and p.stem != ".tmp")
+    return list(reversed(files))
+
+
+def clean(backup_dir: str | Path, *, keep: int = 10, dry_run: bool = False) -> list[Path]:
+    # Remove old snapshots, keeping the `keep` most recent
+    snaps = list_snapshots(backup_dir)
+    if len(snaps) <= keep:
+        return []
+    to_remove = snaps[keep:]
+    if not dry_run:
+        for p in to_remove:
+            p.unlink()
+    return to_remove