json-database 0.10.2a1__tar.gz → 1.0.2a1__tar.gz

{json_database-0.10.2a1 → json_database-1.0.2a1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: json_database
-Version: 0.10.2a1
+Version: 1.0.2a1
 Summary: searchable json database with persistence
 Author-email: jarbasAI <jarbasai@mailfence.com>
 License: MIT
@@ -12,7 +12,7 @@ Requires-Dist: combo_lock<1.0.0,>=0.2.1
 Provides-Extra: crypto
 Requires-Dist: pycryptodomex; extra == "crypto"
 Provides-Extra: hpm
-Requires-Dist: hivemind-plugin-manager<1.0.0,>=0.5.0; extra == "hpm"
+Requires-Dist: hivemind-json-db-plugin>=0.0.3a2; extra == "hpm"
 Provides-Extra: test
 Requires-Dist: coveralls>=1.8.2; extra == "test"
 Requires-Dist: flake8>=3.7.9; extra == "test"
@@ -20,7 +20,6 @@ Requires-Dist: pytest>=5.2.4; extra == "test"
 Requires-Dist: pytest-cov>=2.8.1; extra == "test"
 Requires-Dist: cov-core>=1.15.0; extra == "test"
 Requires-Dist: pycryptodomex; extra == "test"
-Requires-Dist: hivemind-plugin-manager<1.0.0,>=0.5.0; extra == "test"
 Dynamic: license-file
 
 # json_database
@@ -80,7 +79,6 @@ results = Query(db).equal("role", "user").build()
 - File locking via `combo_lock` for safe concurrent access
 - Supports commented JSON files (`//` and `#` line comments)
 - Arbitrary Python objects stored via automatic `jsonify_recursively` conversion
-- HiveMind plugin (`hivemind-json-db-plugin`) for voice assistant integration
 
 ## Configuration / Key Options
 
@@ -116,15 +114,17 @@ results = Query(db).equal("role", "user").build()
 
 ## HiveMind Integration
 
-This project includes a native [hivemind-plugin-manager](https://github.com/JarbasHiveMind/hivemind-plugin-manager)
-integration (`>=0.5.0`), providing JSON-backed storage for HiveMind client
-credentials and permissions via the `hivemind-json-db-plugin` entry point.
-
-The storage layer is schema-less: the entire `Client.__dict__` is persisted
-per record, so new `Client` fields (e.g. the `metadata` dict added in
-plugin-manager 0.5.0) round-trip transparently without changes here. See
-[Architecture → HiveMind Plugin](docs/ARCHITECTURE.md#hivemind-plugin) for
-the storage shape and the deep-copy aliasing contract.
+The HiveMind database-plugin adapter that used to ship as
+`json_database.hpm:JsonDB` has been extracted into its own package,
+[`hivemind-json-db-plugin`](https://github.com/JarbasHiveMind/hivemind-json-db-plugin),
+so it can release on a HiveMind-aligned cadence and `json_database` doesn't pull
+in `hivemind-plugin-manager` for users who don't need it.
+
+For the 1.x line, `pip install json_database[hpm]` continues to work — it now
+transitively installs `hivemind-json-db-plugin` so the `hivemind.database`
+entry point remains available without code changes. **The `[hpm]` extra will
+be removed in 2.0.0;** users should migrate to
+`pip install hivemind-json-db-plugin` directly.
 
 ## License
 

{json_database-0.10.2a1 → json_database-1.0.2a1}/README.md

@@ -55,7 +55,6 @@ results = Query(db).equal("role", "user").build()
 - File locking via `combo_lock` for safe concurrent access
 - Supports commented JSON files (`//` and `#` line comments)
 - Arbitrary Python objects stored via automatic `jsonify_recursively` conversion
-- HiveMind plugin (`hivemind-json-db-plugin`) for voice assistant integration
 
 ## Configuration / Key Options
 
@@ -91,15 +90,17 @@ results = Query(db).equal("role", "user").build()
 
 ## HiveMind Integration
 
-This project includes a native [hivemind-plugin-manager](https://github.com/JarbasHiveMind/hivemind-plugin-manager)
-integration (`>=0.5.0`), providing JSON-backed storage for HiveMind client
-credentials and permissions via the `hivemind-json-db-plugin` entry point.
-
-The storage layer is schema-less: the entire `Client.__dict__` is persisted
-per record, so new `Client` fields (e.g. the `metadata` dict added in
-plugin-manager 0.5.0) round-trip transparently without changes here. See
-[Architecture → HiveMind Plugin](docs/ARCHITECTURE.md#hivemind-plugin) for
-the storage shape and the deep-copy aliasing contract.
+The HiveMind database-plugin adapter that used to ship as
+`json_database.hpm:JsonDB` has been extracted into its own package,
+[`hivemind-json-db-plugin`](https://github.com/JarbasHiveMind/hivemind-json-db-plugin),
+so it can release on a HiveMind-aligned cadence and `json_database` doesn't pull
+in `hivemind-plugin-manager` for users who don't need it.
+
+For the 1.x line, `pip install json_database[hpm]` continues to work — it now
+transitively installs `hivemind-json-db-plugin` so the `hivemind.database`
+entry point remains available without code changes. **The `[hpm]` extra will
+be removed in 2.0.0;** users should migrate to
+`pip install hivemind-json-db-plugin` directly.
 
 ## License
 

json_database-1.0.2a1/json_database/version.py

@@ -0,0 +1,8 @@
+# START_VERSION_BLOCK
+VERSION_MAJOR = 1
+VERSION_MINOR = 0
+VERSION_BUILD = 2
+VERSION_ALPHA = 1
+# END_VERSION_BLOCK
+
+__version__ = f"{VERSION_MAJOR}.{VERSION_MINOR}.{VERSION_BUILD}" + (f"a{VERSION_ALPHA}" if VERSION_ALPHA else "")

{json_database-0.10.2a1 → json_database-1.0.2a1}/json_database.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: json_database
-Version: 0.10.2a1
+Version: 1.0.2a1
 Summary: searchable json database with persistence
 Author-email: jarbasAI <jarbasai@mailfence.com>
 License: MIT
@@ -12,7 +12,7 @@ Requires-Dist: combo_lock<1.0.0,>=0.2.1
 Provides-Extra: crypto
 Requires-Dist: pycryptodomex; extra == "crypto"
 Provides-Extra: hpm
-Requires-Dist: hivemind-plugin-manager<1.0.0,>=0.5.0; extra == "hpm"
+Requires-Dist: hivemind-json-db-plugin>=0.0.3a2; extra == "hpm"
 Provides-Extra: test
 Requires-Dist: coveralls>=1.8.2; extra == "test"
 Requires-Dist: flake8>=3.7.9; extra == "test"
@@ -20,7 +20,6 @@ Requires-Dist: pytest>=5.2.4; extra == "test"
 Requires-Dist: pytest-cov>=2.8.1; extra == "test"
 Requires-Dist: cov-core>=1.15.0; extra == "test"
 Requires-Dist: pycryptodomex; extra == "test"
-Requires-Dist: hivemind-plugin-manager<1.0.0,>=0.5.0; extra == "test"
 Dynamic: license-file
 
 # json_database
@@ -80,7 +79,6 @@ results = Query(db).equal("role", "user").build()
 - File locking via `combo_lock` for safe concurrent access
 - Supports commented JSON files (`//` and `#` line comments)
 - Arbitrary Python objects stored via automatic `jsonify_recursively` conversion
-- HiveMind plugin (`hivemind-json-db-plugin`) for voice assistant integration
 
 ## Configuration / Key Options
 
@@ -116,15 +114,17 @@ results = Query(db).equal("role", "user").build()
 
 ## HiveMind Integration
 
-This project includes a native [hivemind-plugin-manager](https://github.com/JarbasHiveMind/hivemind-plugin-manager)
-integration (`>=0.5.0`), providing JSON-backed storage for HiveMind client
-credentials and permissions via the `hivemind-json-db-plugin` entry point.
-
-The storage layer is schema-less: the entire `Client.__dict__` is persisted
-per record, so new `Client` fields (e.g. the `metadata` dict added in
-plugin-manager 0.5.0) round-trip transparently without changes here. See
-[Architecture → HiveMind Plugin](docs/ARCHITECTURE.md#hivemind-plugin) for
-the storage shape and the deep-copy aliasing contract.
+The HiveMind database-plugin adapter that used to ship as
+`json_database.hpm:JsonDB` has been extracted into its own package,
+[`hivemind-json-db-plugin`](https://github.com/JarbasHiveMind/hivemind-json-db-plugin),
+so it can release on a HiveMind-aligned cadence and `json_database` doesn't pull
+in `hivemind-plugin-manager` for users who don't need it.
+
+For the 1.x line, `pip install json_database[hpm]` continues to work — it now
+transitively installs `hivemind-json-db-plugin` so the `hivemind.database`
+entry point remains available without code changes. **The `[hpm]` extra will
+be removed in 2.0.0;** users should migrate to
+`pip install hivemind-json-db-plugin` directly.
 
 ## License
 

{json_database-0.10.2a1 → json_database-1.0.2a1}/json_database.egg-info/SOURCES.txt

@@ -4,7 +4,6 @@ pyproject.toml
 json_database/__init__.py
 json_database/crypto.py
 json_database/exceptions.py
-json_database/hpm.py
 json_database/search.py
 json_database/utils.py
 json_database/version.py
@@ -12,7 +11,6 @@ json_database/xdg_utils.py
 json_database.egg-info/PKG-INFO
 json_database.egg-info/SOURCES.txt
 json_database.egg-info/dependency_links.txt
-json_database.egg-info/entry_points.txt
 json_database.egg-info/requires.txt
 json_database.egg-info/top_level.txt
 test/test_crypto.py
@@ -20,7 +18,6 @@ test/test_database.py
 test/test_e2e_user_database.py
 test/test_encrypted_storage.py
 test/test_exceptions.py
-test/test_hpm.py
 test/test_query.py
 test/test_search.py
 test/test_storage.py

{json_database-0.10.2a1 → json_database-1.0.2a1}/json_database.egg-info/requires.txt

@@ -4,7 +4,7 @@ combo_lock<1.0.0,>=0.2.1
 pycryptodomex
 
 [hpm]
-hivemind-plugin-manager<1.0.0,>=0.5.0
+hivemind-json-db-plugin>=0.0.3a2
 
 [test]
 coveralls>=1.8.2
@@ -13,4 +13,3 @@ pytest>=5.2.4
 pytest-cov>=2.8.1
 cov-core>=1.15.0
 pycryptodomex
-hivemind-plugin-manager<1.0.0,>=0.5.0

{json_database-0.10.2a1 → json_database-1.0.2a1}/pyproject.toml

@@ -1,10 +1,10 @@
 [build-system]
-requires = ["setuptools>=42", "wheel"]
+requires = ["setuptools>=61", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [project]
 name = "json_database"
-version = "0.10.2a1"
+dynamic = ["version"]
 description = "searchable json database with persistence"
 readme = "README.md"
 license = { text = "MIT" }
@@ -16,7 +16,16 @@ dependencies = [
 
 [project.optional-dependencies]
 crypto = ["pycryptodomex"]
-hpm = ["hivemind-plugin-manager>=0.5.0,<1.0.0"]
+# Back-compat shim for the 1.x line — ``json_database[hpm]`` keeps
+# resolving to a working install of the HiveMind database plugin so
+# existing ``pip install json_database[hpm]`` users don't break on
+# upgrade. The adapter itself was extracted into
+# https://github.com/JarbasHiveMind/hivemind-json-db-plugin; this
+# extra simply pulls it in transitively so the
+# ``hivemind-json-db-plugin`` entry point remains available.
+# This extra will be REMOVED in 2.0.0 — migrate to
+# ``pip install hivemind-json-db-plugin`` directly.
+hpm = ["hivemind-json-db-plugin>=0.0.3a2"]
 test = [
     "coveralls>=1.8.2",
     "flake8>=3.7.9",
@@ -24,14 +33,13 @@ test = [
     "pytest-cov>=2.8.1",
     "cov-core>=1.15.0",
     "pycryptodomex",
-    "hivemind-plugin-manager>=0.5.0,<1.0.0",
 ]
 
 [project.urls]
 Homepage = "https://github.com/TigreGotico/json_database"
 
-[project.entry-points."hivemind.database"]
-"hivemind-json-db-plugin" = "json_database.hpm:JsonDB"
+[tool.setuptools.dynamic]
+version = {attr = "json_database.version.__version__"}
 
 [tool.setuptools.packages.find]
 where = ["."]

json_database-0.10.2a1/json_database/hpm.py

@@ -1,105 +0,0 @@
-import copy
-from hivemind_plugin_manager.database import Client, AbstractDB, cast2client
-from ovos_utils.log import LOG
-from ovos_utils.xdg_utils import xdg_data_home
-from typing import Union, Iterable, List, Optional
-from json_database import JsonStorageXDG, EncryptedJsonStorageXDG
-from dataclasses import dataclass
-
-
-@dataclass
-class JsonDB(AbstractDB):
-    """HiveMind Database implementation using JSON files."""
-    name: str = "clients"
-    subfolder: str = "hivemind-core"
-    password: Optional[str] = None
-
-    def __post_init__(self):
-        if self.password:
-            self._db = EncryptedJsonStorageXDG(encrypt_key=self.password,
-                                               name=self.name,
-                                               subfolder=self.subfolder,
-                                               xdg_folder=xdg_data_home())
-        else:
-            self._db = JsonStorageXDG(self.name,
-                                      subfolder=self.subfolder,
-                                      xdg_folder=xdg_data_home())
-        LOG.debug(f"json database path: {self._db.path}")
-
-    def sync(self):
-        """update db from disk if needed"""
-        self._db.reload()
-
-    def add_item(self, client: Client) -> bool:
-        """
-        Add a client to the JSON database.
-
-        Args:
-            client: The client to be added.
-
-        Returns:
-            True if the addition was successful, False otherwise.
-        """
-        # Deep copy to break aliasing: dict(client.__dict__) is shallow, so
-        # mutable fields (metadata dict, intent/skill/message/allowed lists)
-        # would otherwise reference caller state and pick up later mutations
-        # on the next commit. Snapshot once on insert.
-        client_data = copy.deepcopy(client.__dict__)
-        self._db[client.client_id] = client_data
-        return True
-
-    def search_by_value(self, key: str, val: Union[str, bool, int, float]) -> List[Client]:
-        """
-        Search for clients by a specific key-value pair in the JSON database.
-
-        Args:
-            key: The key to search by.
-            val: The value to search for.
-
-        Returns:
-            A list of clients that match the search criteria.
-        """
-        res = []
-        if key == "client_id":
-            v = self._db.get(val)
-            if v:
-                res.append(cast2client(v))
-        else:
-            for client in self._db.values():
-                v = client.get(key)
-                if v == val:
-                    res.append(cast2client(client))
-        return res
-
-    def __len__(self) -> int:
-        """
-        Get the number of clients in the database.
-
-        Returns:
-            The number of clients in the database.
-        """
-        return len(self._db)
-
-    def __iter__(self) -> Iterable['Client']:
-        """
-        Iterate over all clients in the JSON database.
-
-        Returns:
-            An iterator over the clients in the database.
-        """
-        for item in self._db.values():
-            yield cast2client(item)
-
-    def commit(self) -> bool:
-        """
-        Commit changes to the JSON database.
-
-        Returns:
-            True if the commit was successful, False otherwise.
-        """
-        try:
-            self._db.store()
-            return True
-        except Exception as e:
-            LOG.error(f"Failed to save {self._db.path} - {e}")
-            return False

json_database-0.10.2a1/json_database/version.py

@@ -1,6 +0,0 @@
-# START_VERSION_BLOCK
-VERSION_MAJOR = 0
-VERSION_MINOR = 10
-VERSION_BUILD = 4
-VERSION_ALPHA = 2
-# END_VERSION_BLOCK

json_database-0.10.2a1/json_database.egg-info/entry_points.txt

@@ -1,2 +0,0 @@
-[hivemind.database]
-hivemind-json-db-plugin = json_database.hpm:JsonDB

json_database-0.10.2a1/test/test_hpm.py

@@ -1,176 +0,0 @@
-from hivemind_plugin_manager.database import Client
-
-import json_database.hpm as hpm
-from json_database.hpm import JsonDB
-
-
-def make_db(tmp_path, monkeypatch) -> JsonDB:
-    """Return an initialized JsonDB backed by a temp XDG data path."""
-    monkeypatch.setattr(hpm, "xdg_data_home", lambda: str(tmp_path))
-    return JsonDB()
-
-
-def make_client(*, metadata=None, **kwargs) -> Client:
-    """Build a Client with optional metadata."""
-    client = Client(**kwargs)
-    if metadata is not None:
-        client.metadata = metadata
-    return client
-
-
-def test_hivemind_client_metadata_survives_search_round_trip(tmp_path, monkeypatch):
-    """Client metadata survives add and search in JsonDB."""
-    db = make_db(tmp_path, monkeypatch)
-    client = make_client(
-        client_id=1,
-        api_key="alpha-key",
-        name="alpha",
-        metadata={"owner_id": "owner-123"},
-    )
-
-    assert db.add_item(client)
-    found = db.search_by_value("api_key", "alpha-key")
-
-    assert len(found) == 1
-    assert found[0].metadata == {"owner_id": "owner-123"}
-
-
-def test_hivemind_client_metadata_survives_iteration(tmp_path, monkeypatch):
-    """Client metadata survives iteration in JsonDB."""
-    db = make_db(tmp_path, monkeypatch)
-    client = make_client(
-        client_id=1,
-        api_key="alpha-key",
-        name="alpha",
-        metadata={"owner_id": "owner-123"},
-    )
-
-    assert db.add_item(client)
-    found = list(db)
-
-    assert len(found) == 1
-    assert found[0].metadata == {"owner_id": "owner-123"}
-
-
-def test_hivemind_client_metadata_record_round_trips(tmp_path, monkeypatch):
-    """Stored metadata round-trips through search_by_value."""
-    db = make_db(tmp_path, monkeypatch)
-    db._db[1] = {
-        "client_id": 1,
-        "api_key": "alpha-key",
-        "name": "alpha",
-        "metadata": {"owner_id": "owner-123"},
-    }
-
-    found = db.search_by_value("api_key", "alpha-key")
-
-    assert len(found) == 1
-    assert found[0].api_key == "alpha-key"
-    assert found[0].metadata == {"owner_id": "owner-123"}
-
-
-def test_metadata_defaults_to_empty_when_missing(tmp_path, monkeypatch):
-    """Clients added without a metadata dict get persisted with metadata={}."""
-    db = make_db(tmp_path, monkeypatch)
-    db.add_item(Client(client_id=1, api_key="k", name="a"))
-    assert db._db[1]["metadata"] == {}
-    found = db.search_by_value("api_key", "k")
-    assert found[0].metadata == {}
-
-
-def test_search_by_client_id_returns_metadata(tmp_path, monkeypatch):
-    """The client_id search path also preserves metadata."""
-    db = make_db(tmp_path, monkeypatch)
-    db.add_item(make_client(client_id=1, api_key="k", name="a",
-                            metadata={"tier": "gold"}))
-    found = db.search_by_value("client_id", 1)
-    assert len(found) == 1
-    assert found[0].metadata == {"tier": "gold"}
-
-
-def test_nested_and_non_ascii_metadata_round_trip(tmp_path, monkeypatch):
-    """Nested structures and non-ASCII characters survive add → iterate."""
-    db = make_db(tmp_path, monkeypatch)
-    meta = {
-        "owner": {"id": "owner-1", "tags": ["a", "b"]},
-        "name": "Zé Ninguém",
-        "emoji": "🚀",
-    }
-    db.add_item(make_client(client_id=1, api_key="k", name="a", metadata=meta))
-    found = list(db)
-    assert found[0].metadata == meta
-
-
-def test_metadata_survives_commit_and_reload(tmp_path, monkeypatch):
-    """add_item → commit → new JsonDB pointed at the same path reads metadata back."""
-    db = make_db(tmp_path, monkeypatch)
-    db.add_item(make_client(client_id=1, api_key="k", name="a",
-                            metadata={"owner": "owner-1"}))
-    assert db.commit()
-
-    # Fresh JsonDB instance against the same xdg_data_home path
-    fresh = make_db(tmp_path, monkeypatch)
-    found = fresh.search_by_value("api_key", "k")
-    assert len(found) == 1
-    assert found[0].metadata == {"owner": "owner-1"}
-
-
-def test_add_item_snapshots_metadata_against_caller_mutation(tmp_path, monkeypatch):
-    """Caller mutations to client.metadata after add_item must not leak into
-    the stored record — including mutations of nested dicts."""
-    db = make_db(tmp_path, monkeypatch)
-    meta = {"v": "original", "nested": {"k": "n_original"}}
-    client = make_client(client_id=1, api_key="k", name="a", metadata=meta)
-    db.add_item(client)
-
-    meta["v"] = "mutated"
-    meta["nested"]["k"] = "n_mutated"
-    client.metadata["added"] = "later"
-
-    found = db.search_by_value("api_key", "k")
-    assert found[0].metadata == {"v": "original", "nested": {"k": "n_original"}}
-
-
-def test_add_item_snapshots_list_fields_against_caller_mutation(tmp_path, monkeypatch):
-    """Same aliasing bug applied to all mutable list fields: caller mutation
-    of intent_blacklist / skill_blacklist / message_blacklist / allowed_types
-    after add_item must not leak into the stored record."""
-    db = make_db(tmp_path, monkeypatch)
-    intents = ["skill:a"]
-    skills = ["skill:b"]
-    messages = ["msg:c"]
-    allowed = ["recognizer_loop:utterance", "speak:b64_audio"]
-    client = Client(
-        client_id=1, api_key="k", name="a",
-        intent_blacklist=intents,
-        skill_blacklist=skills,
-        message_blacklist=messages,
-        allowed_types=allowed,
-    )
-    db.add_item(client)
-
-    # mutate the caller-side lists and the lists still on the client
-    intents.append("skill:leaked")
-    client.skill_blacklist.append("skill:leaked")
-    messages.append("msg:leaked")
-    client.allowed_types.append("speak:leaked")
-
-    found = db.search_by_value("api_key", "k")
-    assert found[0].intent_blacklist == ["skill:a"]
-    assert found[0].skill_blacklist == ["skill:b"]
-    assert found[0].message_blacklist == ["msg:c"]
-    # allowed_types: __post_init__ guarantees "recognizer_loop:utterance" is
-    # in the list, so verify the leaked entry isn't there.
-    assert "speak:leaked" not in found[0].allowed_types
-
-
-def test_add_item_overwrites_metadata_for_same_client_id(tmp_path, monkeypatch):
-    """Re-adding a client with the same client_id replaces stored metadata."""
-    db = make_db(tmp_path, monkeypatch)
-    db.add_item(make_client(client_id=1, api_key="k", name="a",
-                            metadata={"v": "old"}))
-    db.add_item(make_client(client_id=1, api_key="k", name="a",
-                            metadata={"v": "new", "extra": "x"}))
-    found = db.search_by_value("api_key", "k")
-    assert len(found) == 1
-    assert found[0].metadata == {"v": "new", "extra": "x"}