kraph 3.0.1__tar.gz → 4.1.0__tar.gz

kraph-4.1.0/PKG-INFO

@@ -0,0 +1,105 @@
+Metadata-Version: 2.5
+Name: kraph
+Version: 4.1.0
+Summary: the arkitekt knowledge graph
+Author-email: jhnnsrs <jhnnsrs@gmail.com>
+License-Expression: GPL-3.0-or-later
+Requires-Python: <4.0,>=3.11
+Requires-Dist: arkitekt-spec>=1.4
+Requires-Dist: dokker>=2.8
+Requires-Dist: fakts>=4
+Requires-Dist: rath>=4.1.1
+Requires-Dist: websockets>=15.0.1
+Description-Content-Type: text/markdown
+
+# kraph
+
+[![PyPI version](https://badge.fury.io/py/kraph.svg)](https://pypi.org/project/kraph/)
+[![PyPI pyversions](https://img.shields.io/pypi/pyversions/kraph.svg)](https://pypi.python.org/pypi/kraph/)
+
+The python client for kraph, the [Arkitekt](https://arkitekt.live) knowledge graph service built
+around Apache AGE: recording claims about entities, events, measurements and metrics, backed by the
+structures (images, tables, …) that are evidence for them, and drawing them into graphs.
+
+## Installation
+
+```bash
+pip install kraph
+```
+
+With arkitekt, `pip install "arkitekt[rekuest,kraph]"` brings it in.
+
+## Concepts
+
+- **Claims** — an entity exists, a structure measures it, two things are related — are recorded
+  under a *term*, a word your organization owns, never under a graph. Retracting a claim records a
+  position rather than deleting anything.
+- **Graphs** are views. A graph declares *categories* (entity, relation, measurement, event, …)
+  that say what its words mean, and draws the claims made under those words.
+
+## Usage
+
+Every kraph operation is a method of the `Kraph` client, in a blocking and an `a`-prefixed async
+flavour (`kraph.create_graph(...)`, `await kraph.acreate_graph(...)`). What a call returns remembers
+the client, so follow-ups from a result go through the same client.
+
+### In an arkitekt app
+
+Add the service to your app and ask for `kraph: Kraph`; the client is injected by annotation.
+Graphs, categories, structures, metrics, terms and more travel between actions by id
+(`@kraph/graph`, `@kraph/entitycategory`, `@kraph/structure`, `@kraph/term`, …), so an action can
+take and return them directly:
+
+```python
+from arkitekt import App, run
+from kraph import Kraph, kraph_service
+
+app = App("neuron-claims", "0.1.0", services=[kraph_service])
+
+
+@app.action
+def claim_neuron(kraph: Kraph) -> str:
+    """Claim Neuron
+
+    Records that a neuron exists.
+    """
+    asserted = kraph.assert_entity_exists(
+        term="Neuron", supporting_evidence=[], derived_from=[], same_as=[]
+    )
+    return asserted.instance.id
+
+
+if __name__ == "__main__":
+    run(app)
+```
+
+### From a script
+
+```python
+from arkitekt import easy
+from kraph import kraph_service
+
+with easy("my-script", kraph_service) as kraph:
+    graph = kraph.create_graph(name="Neurons", backfill=False)
+    kraph.create_entity_category(
+        key="Neuron",
+        ontology_references=[],
+        property_definitions=[],
+        graph=graph.id,
+        backfill=True,
+    )
+
+    asserted = kraph.assert_entity_exists(
+        term="Neuron", supporting_evidence=[], derived_from=[], same_as=[]
+    )
+    print(asserted.is_drawn)  # True: the graph declares "Neuron", so it draws the claim
+```
+
+## Testing
+
+```bash
+uv run pytest -m "not integration"   # no server needed
+uv run pytest -m integration          # a real kraph via dokker
+```
+
+See [RELEASING.md](RELEASING.md) for how versions are cut.

kraph-4.1.0/README.md

@@ -0,0 +1,91 @@
+# kraph
+
+[![PyPI version](https://badge.fury.io/py/kraph.svg)](https://pypi.org/project/kraph/)
+[![PyPI pyversions](https://img.shields.io/pypi/pyversions/kraph.svg)](https://pypi.python.org/pypi/kraph/)
+
+The python client for kraph, the [Arkitekt](https://arkitekt.live) knowledge graph service built
+around Apache AGE: recording claims about entities, events, measurements and metrics, backed by the
+structures (images, tables, …) that are evidence for them, and drawing them into graphs.
+
+## Installation
+
+```bash
+pip install kraph
+```
+
+With arkitekt, `pip install "arkitekt[rekuest,kraph]"` brings it in.
+
+## Concepts
+
+- **Claims** — an entity exists, a structure measures it, two things are related — are recorded
+  under a *term*, a word your organization owns, never under a graph. Retracting a claim records a
+  position rather than deleting anything.
+- **Graphs** are views. A graph declares *categories* (entity, relation, measurement, event, …)
+  that say what its words mean, and draws the claims made under those words.
+
+## Usage
+
+Every kraph operation is a method of the `Kraph` client, in a blocking and an `a`-prefixed async
+flavour (`kraph.create_graph(...)`, `await kraph.acreate_graph(...)`). What a call returns remembers
+the client, so follow-ups from a result go through the same client.
+
+### In an arkitekt app
+
+Add the service to your app and ask for `kraph: Kraph`; the client is injected by annotation.
+Graphs, categories, structures, metrics, terms and more travel between actions by id
+(`@kraph/graph`, `@kraph/entitycategory`, `@kraph/structure`, `@kraph/term`, …), so an action can
+take and return them directly:
+
+```python
+from arkitekt import App, run
+from kraph import Kraph, kraph_service
+
+app = App("neuron-claims", "0.1.0", services=[kraph_service])
+
+
+@app.action
+def claim_neuron(kraph: Kraph) -> str:
+    """Claim Neuron
+
+    Records that a neuron exists.
+    """
+    asserted = kraph.assert_entity_exists(
+        term="Neuron", supporting_evidence=[], derived_from=[], same_as=[]
+    )
+    return asserted.instance.id
+
+
+if __name__ == "__main__":
+    run(app)
+```
+
+### From a script
+
+```python
+from arkitekt import easy
+from kraph import kraph_service
+
+with easy("my-script", kraph_service) as kraph:
+    graph = kraph.create_graph(name="Neurons", backfill=False)
+    kraph.create_entity_category(
+        key="Neuron",
+        ontology_references=[],
+        property_definitions=[],
+        graph=graph.id,
+        backfill=True,
+    )
+
+    asserted = kraph.assert_entity_exists(
+        term="Neuron", supporting_evidence=[], derived_from=[], same_as=[]
+    )
+    print(asserted.is_drawn)  # True: the graph declares "Neuron", so it draws the claim
+```
+
+## Testing
+
+```bash
+uv run pytest -m "not integration"   # no server needed
+uv run pytest -m integration          # a real kraph via dokker
+```
+
+See [RELEASING.md](RELEASING.md) for how versions are cut.

kraph-4.1.0/kraph/__init__.py

@@ -0,0 +1,7 @@
+from .kraph import Kraph
+
+
+# The service is declared with arkitekt-spec, a core dependency: it is always there.
+from .arkitekt import kraph as kraph_service
+
+__all__ = ["Kraph", "kraph_service"]

{kraph-3.0.1 → kraph-4.1.0}/kraph/arkitekt.py

@@ -35,8 +35,8 @@ from rath.links.graphql_ws import GraphQLWSLink
 from rath.links.shrink import ShrinkingLink
 from rath.links.split import SplitLink
 
-from rekuest.app import AppRegistry
-from rekuest.widgets import SearchWidget
+from arkitekt_spec.declare.app import AppRegistry
+from arkitekt_spec.declare.widgets import SearchWidget
 
 from kraph.api.schema import (
     EntityCategory,
@@ -111,8 +111,8 @@ def kraph(
                 FaktsAuthLink(token_loader=tokens),
                 UploadLink(datalayer=store),
                 SplitLink(
-                    left=AIOHttpLink(endpoint_url=kraph.to_http_path("graphql")),
-                    right=GraphQLWSLink(ws_endpoint_url=kraph.to_ws_path("graphql")),
+                    left=AIOHttpLink(endpoint_url=kraph.to_http_path("graphql"), proxy=kraph.proxy),
+                    right=GraphQLWSLink(ws_endpoint_url=kraph.to_ws_path("graphql"), proxy=kraph.proxy),
                     split=lambda o: o.node.operation != OperationType.SUBSCRIPTION,
                 ),
             )

{kraph-3.0.1 → kraph-4.1.0}/kraph/datalayer.py

@@ -52,6 +52,9 @@ class DataLayer(KoiledModel):
     """
 
     endpoint_url: str = ""
+    proxy: str | None = None
+    """The HTTP forward proxy (``http://host:port``) the store is only reachable
+    through, when it sits on a private mesh. ``None`` connects directly."""
 
 
     @classmethod
@@ -64,7 +67,7 @@ class DataLayer(KoiledModel):
         Returns:
             The datalayer, ready to use.
         """
-        return cls(endpoint_url=alias.to_http_path())
+        return cls(endpoint_url=alias.to_http_path(), proxy=alias.proxy)
 
     async def get_endpoint_url(self):
         return self.endpoint_url

{kraph-3.0.1 → kraph-4.1.0}/kraph/io.py

@@ -12,7 +12,10 @@ async def adownload_file(datalayer: "DataLayer", presigned_url: str, file_name:
     endpoint_url = await datalayer.get_endpoint_url()
 
     async with aiohttp.ClientSession() as session:
-        async with session.get(endpoint_url + presigned_url) as response:
+        # ``proxy=None`` is aiohttp's own default, so an unproxied datalayer is unchanged.
+        async with session.get(
+            endpoint_url + presigned_url, proxy=datalayer.proxy
+        ) as response:
             with open(file_name, "wb") as file:
                 while True:
                     chunk = await response.content.read(

{kraph-3.0.1 → kraph-4.1.0}/kraph/traits.py

@@ -32,7 +32,7 @@ from rath.turms.utils import get_attributes_or_error
 from kraph.client import client_of
 
 if TYPE_CHECKING:
-    from rekuest.structures.registry import StructureRegistry
+    from arkitekt_spec.declare.structures.registry import StructureRegistry
 
     from kraph.kraph import Kraph
 

{kraph-3.0.1 → kraph-4.1.0}/pyproject.toml

@@ -10,9 +10,12 @@ requires-python = ">=3.11, <4.0"
 license = "GPL-3.0-or-later"
 dependencies = [
     "dokker>=2.8",
-    "rath>=4",
-    "rekuest>=4",
+    "rath>=4.1.1",
     "websockets>=15.0.1",
+    # The service and structures are declared with arkitekt-spec.
+    "arkitekt-spec>=1.4",
+    # The service wiring (Alias, Require, FaktsAuthLink); it came through rekuest before.
+    "fakts>=4",
 ]
 
 [project.optional-dependencies]

kraph-3.0.1/PKG-INFO

@@ -1,30 +0,0 @@
-Metadata-Version: 2.5
-Name: kraph
-Version: 3.0.1
-Summary: the arkitekt knowledge graph
-Author-email: jhnnsrs <jhnnsrs@gmail.com>
-License-Expression: GPL-3.0-or-later
-Requires-Python: <4.0,>=3.11
-Requires-Dist: dokker>=2.8
-Requires-Dist: rath>=4
-Requires-Dist: rekuest>=4
-Requires-Dist: websockets>=15.0.1
-Description-Content-Type: text/markdown
-
-# kraph
-
-Kraph is a Python library for creating and manipulating knowledge graphs build around apache AGE. 
-
-## Features
-
-- Create and manipulate knowledge graphs
-- Query knowledge graphs using Cypher
-- Ontology support (custom entities and relationships)
-- GraphQL API for adding and querying data
-
-
-## Installation
-
-```bash
-pip install kraph
-```

kraph-3.0.1/README.md

@@ -1,17 +0,0 @@
-# kraph
-
-Kraph is a Python library for creating and manipulating knowledge graphs build around apache AGE. 
-
-## Features
-
-- Create and manipulate knowledge graphs
-- Query knowledge graphs using Cypher
-- Ontology support (custom entities and relationships)
-- GraphQL API for adding and querying data
-
-
-## Installation
-
-```bash
-pip install kraph
-```

kraph-3.0.1/kraph/__init__.py

@@ -1,18 +0,0 @@
-from .kraph import Kraph
-
-
-try:
-    from .arkitekt import kraph as kraph_service
-except ImportError as e:
-    # Only "rekuest is not installed" may pass silently. Anything else that fails
-    # to import here (a renamed query, a rekuest too old for what the module
-    # needs) is a bug, and hiding it makes this package's service vanish
-    # without a word. Whether it is installed is asked the plain way.
-    try:
-        import rekuest  # noqa: F401 -- presence is the question
-    except ImportError:
-        pass
-    else:
-        raise e
-
-__all__ = ["Kraph", "kraph_service"]