pydatagraphs 0.4.6__tar.gz

pydatagraphs-0.4.6/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+Copyright (c) 2026 Data Language
+
+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.

pydatagraphs-0.4.6/PKG-INFO

@@ -0,0 +1,164 @@
+Metadata-Version: 2.3
+Name: pydatagraphs
+Version: 0.4.6
+Summary: Datagraphs python client
+Keywords: datagraphs,knowledge-graph,api-client,linked-data
+Author: DataGraphs
+Author-email: DataGraphs <info@datagraphs.com>
+License: The MIT License (MIT)
+         Copyright (c) 2026 Data Language
+         
+         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.
+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.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: requests>=2.32.4
+Requires-Python: >=3.12
+Project-URL: Changelog, https://github.com/datalanguage/datagraphs-client-py/blob/main/CHANGELOG.md
+Project-URL: Homepage, https://datagraphs.com
+Project-URL: Issues, https://github.com/datalanguage/datagraphs-client-py/issues
+Project-URL: Repository, https://github.com/datalanguage/datagraphs-client-py
+Description-Content-Type: text/markdown
+
+# DataGraphs Python Client
+
+Python client library for [DataGraphs](https://datagraphs.com).
+
+## Installation
+
+```bash
+uv add pydatagraphs
+```
+or
+```bash
+pip install pydatagraphs
+```
+
+## Quick starts
+
+```python
+from datagraphs import Client
+
+# Connect to a project
+client = Client(
+    project_name="my-project",
+    api_key="your-api-key",
+)
+
+# Check the API is reachable
+print(client.status())
+
+# Retrieve all entities of a given type
+products = client.get("Product")
+
+# Query with filters and pagination
+results = client.query(q="Acme", page_size=50)
+```
+
+```python
+from datagraphs import Client, Gateway, Schema
+
+# Connect to a project
+client = Client(
+    project_name="my-project",
+    api_key="your-api-key",
+)
+
+# Read the project schema and dataset configurations
+schema = client.get_schema()
+schema = client.get_datasets()
+
+# Update the project schema and dataset configurations
+client.apply_schema(schema)
+client.apply_datasets(datasets)
+```
+
+```python
+from datagraphs import Client, Gateway, Dataset
+
+# Connect to a project
+client = Client(
+    project_name="my-project",
+    api_key="your-api-key",
+)
+gateway = Gateway(client, schema)
+
+# Load / dump data via the Gateway
+gateway.dump_data("./backup")
+gateway.load_data(from_dir_path="./backup")
+
+# Load / dump project via the Gateway
+schema_output_path = "./schemas/"
+datasets_output_path = "./datasets/"
+gateway.dump_project(schema_output_path, datasets_output_path)
+
+schema_data = load_json("./schemas/myproject-model-v1.0.json")
+datasets_data = load_json("./datasets/myproject-datasets-v1.0.json")
+schema = Schema.create_from(schema_data)
+datasets = [Dataset.create_from(dataset) for dataset in datasets]
+gateway.load_project(schema, datasets)
+
+```
+For full API documentation, please [see here](https://datalanguage.github.io/datagraphs-client-py)
+
+## Authentication
+
+For read-only access, an API key is sufficient. For write operations, supply OAuth credentials as well:
+
+```python
+client = Client(
+    project_name="my-project",
+    api_key="your-api-key",
+    client_id="your-client-id",
+    client_secret="your-client-secret",
+)
+```
+
+## Key classes
+
+| Class | Description |
+|-------|-------------|
+| `Client` | Lower-level HTTP client for the DataGraphs REST API |
+| `Gateway` | Higher-level wrapper class for deploying projects and bulk export/load of data |
+| `Schema` | In-memory representation of a project's domain model |
+| `Dataset` | Represents a dataset within a project |
+
+## Development
+
+Install [uv](https://docs.astral.sh/uv/getting-started/installation/), then:
+
+```bash
+uv sync                                          # create virtualenv & install deps
+uv run pytest tests -v                            # unit tests
+uv run pytest tests_integration -v                # integration tests
+uv run pytest tests -v --capture=tee-sys          # capturing stdout/stderr
+uv run pytest --cov=src --cov-report=html         # coverage report
+uvx ruff check .                                  # lint
+```
+
+## License
+
+[MIT](LICENSE) — Copyright (c) 2026 Data Language
+

pydatagraphs-0.4.6/README.md

@@ -0,0 +1,120 @@
+# DataGraphs Python Client
+
+Python client library for [DataGraphs](https://datagraphs.com).
+
+## Installation
+
+```bash
+uv add pydatagraphs
+```
+or
+```bash
+pip install pydatagraphs
+```
+
+## Quick starts
+
+```python
+from datagraphs import Client
+
+# Connect to a project
+client = Client(
+    project_name="my-project",
+    api_key="your-api-key",
+)
+
+# Check the API is reachable
+print(client.status())
+
+# Retrieve all entities of a given type
+products = client.get("Product")
+
+# Query with filters and pagination
+results = client.query(q="Acme", page_size=50)
+```
+
+```python
+from datagraphs import Client, Gateway, Schema
+
+# Connect to a project
+client = Client(
+    project_name="my-project",
+    api_key="your-api-key",
+)
+
+# Read the project schema and dataset configurations
+schema = client.get_schema()
+schema = client.get_datasets()
+
+# Update the project schema and dataset configurations
+client.apply_schema(schema)
+client.apply_datasets(datasets)
+```
+
+```python
+from datagraphs import Client, Gateway, Dataset
+
+# Connect to a project
+client = Client(
+    project_name="my-project",
+    api_key="your-api-key",
+)
+gateway = Gateway(client, schema)
+
+# Load / dump data via the Gateway
+gateway.dump_data("./backup")
+gateway.load_data(from_dir_path="./backup")
+
+# Load / dump project via the Gateway
+schema_output_path = "./schemas/"
+datasets_output_path = "./datasets/"
+gateway.dump_project(schema_output_path, datasets_output_path)
+
+schema_data = load_json("./schemas/myproject-model-v1.0.json")
+datasets_data = load_json("./datasets/myproject-datasets-v1.0.json")
+schema = Schema.create_from(schema_data)
+datasets = [Dataset.create_from(dataset) for dataset in datasets]
+gateway.load_project(schema, datasets)
+
+```
+For full API documentation, please [see here](https://datalanguage.github.io/datagraphs-client-py)
+
+## Authentication
+
+For read-only access, an API key is sufficient. For write operations, supply OAuth credentials as well:
+
+```python
+client = Client(
+    project_name="my-project",
+    api_key="your-api-key",
+    client_id="your-client-id",
+    client_secret="your-client-secret",
+)
+```
+
+## Key classes
+
+| Class | Description |
+|-------|-------------|
+| `Client` | Lower-level HTTP client for the DataGraphs REST API |
+| `Gateway` | Higher-level wrapper class for deploying projects and bulk export/load of data |
+| `Schema` | In-memory representation of a project's domain model |
+| `Dataset` | Represents a dataset within a project |
+
+## Development
+
+Install [uv](https://docs.astral.sh/uv/getting-started/installation/), then:
+
+```bash
+uv sync                                          # create virtualenv & install deps
+uv run pytest tests -v                            # unit tests
+uv run pytest tests_integration -v                # integration tests
+uv run pytest tests -v --capture=tee-sys          # capturing stdout/stderr
+uv run pytest --cov=src --cov-report=html         # coverage report
+uvx ruff check .                                  # lint
+```
+
+## License
+
+[MIT](LICENSE) — Copyright (c) 2026 Data Language
+

pydatagraphs-0.4.6/pyproject.toml

@@ -0,0 +1,56 @@
+[build-system]
+requires = ["uv_build>=0.7.2,<0.8"]
+build-backend = "uv_build"
+
+[project]
+name = "pydatagraphs"
+version = "0.4.6"
+description = "Datagraphs python client"
+readme = "README.md"
+license = { file = "LICENSE" }
+requires-python = ">=3.12"
+authors = [
+    { name = "DataGraphs", email = "info@datagraphs.com" },
+]
+keywords = ["datagraphs", "knowledge-graph", "api-client", "linked-data"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+]
+dependencies = [
+    "pyyaml>=6.0.3",
+    "requests>=2.32.4",
+]
+
+[project.urls]
+Homepage = "https://datagraphs.com"
+Repository = "https://github.com/datalanguage/datagraphs-client-py"
+Issues = "https://github.com/datalanguage/datagraphs-client-py/issues"
+Changelog = "https://github.com/datalanguage/datagraphs-client-py/blob/main/CHANGELOG.md"
+
+[dependency-groups]
+dev = [
+    "pydoctor>=25.10.1",
+    "pytest>=8.4.1",
+    "pytest-cov>=7.0.0",
+    "pytest-mock>=3.15.1",
+]
+
+[tool.uv.build-backend]
+module-name = "datagraphs"
+
+[tool.pytest.ini_options]
+pythonpath = [
+  "src"
+]
+addopts = "-ra -q"
+testpaths = [
+    "tests",
+    "tests_integration"
+]

pydatagraphs-0.4.6/src/datagraphs/__init__.py

@@ -0,0 +1,20 @@
+"""DataGraphs Python client library."""
+
+from importlib.metadata import version
+from datagraphs.client import Client, AuthenticationError, DatagraphsError
+from datagraphs.gateway import Gateway
+from datagraphs.schema import Schema
+from datagraphs.dataset import Dataset
+
+__version__ = version("pydatagraphs")
+"""The installed version of the pydatagraphs package, read from package metadata."""
+
+__all__ = [
+    "Client",
+    "Gateway",
+    "Schema",
+    "Dataset",
+    "AuthenticationError",
+    "DatagraphsError",
+    "__version__",
+]