From 6e6c077cf9a88d9b1bc1da53391c42e6f934355d Mon Sep 17 00:00:00 2001 From: Jasper Deflander Date: Thu, 13 Oct 2022 10:44:00 +0200 Subject: [PATCH] Rename `agent` package --- README.md | 10 +++++----- src/elimity_insights_client/agent/__init__.py | 1 - src/elimity_insights_client/api/__init__.py | 4 ++++ .../{agent/api.py => api/_api.py} | 16 ++++++++-------- .../{agent => api}/_decode_query_results_page.py | 2 +- .../{agent => api}/_decode_source.py | 2 +- .../{agent => api}/_encode_expression.py | 2 +- .../{agent => api}/_encode_query.py | 4 ++-- .../{agent => api}/expression.py | 0 .../{agent => api}/query.py | 2 +- .../{agent => api}/query_results_page.py | 0 .../{agent => api}/source.py | 0 tests/elimity_insights_client/agent/__init__.py | 1 - tests/elimity_insights_client/api/__init__.py | 1 + .../{agent => api}/query-results-page.json | 0 .../{agent => api}/schema.json | 0 .../{agent => api}/source.json | 0 .../test_decode_query_results_page.py | 4 ++-- .../{agent => api}/test_decode_source.py | 4 ++-- .../{agent => api}/test_encode_query.py | 4 ++-- 20 files changed, 30 insertions(+), 27 deletions(-) delete mode 100644 src/elimity_insights_client/agent/__init__.py create mode 100644 src/elimity_insights_client/api/__init__.py rename src/elimity_insights_client/{agent/api.py => api/_api.py} (71%) rename src/elimity_insights_client/{agent => api}/_decode_query_results_page.py (98%) rename src/elimity_insights_client/{agent => api}/_decode_source.py (96%) rename src/elimity_insights_client/{agent => api}/_encode_expression.py (99%) rename src/elimity_insights_client/{agent => api}/_encode_query.py (98%) rename src/elimity_insights_client/{agent => api}/expression.py (100%) rename src/elimity_insights_client/{agent => api}/query.py (98%) rename src/elimity_insights_client/{agent => api}/query_results_page.py (100%) rename src/elimity_insights_client/{agent => api}/source.py (100%) delete mode 100644 tests/elimity_insights_client/agent/__init__.py create mode 100644 tests/elimity_insights_client/api/__init__.py rename tests/elimity_insights_client/{agent => api}/query-results-page.json (100%) rename tests/elimity_insights_client/{agent => api}/schema.json (100%) rename tests/elimity_insights_client/{agent => api}/source.json (100%) rename tests/elimity_insights_client/{agent => api}/test_decode_query_results_page.py (89%) rename tests/elimity_insights_client/{agent => api}/test_decode_source.py (87%) rename tests/elimity_insights_client/{agent => api}/test_encode_query.py (84%) diff --git a/README.md b/README.md index ea03146..78ca155 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Insights server. ## Usage -### Custom source interactions +### Importing data to custom sources The following snippet shows how to authenticate as a custom source and create a connector log at an Elimity Insights server. You can generate a source identifier and token by visiting the custom source's detail page in Elimity Insights @@ -26,14 +26,14 @@ if __name__ == "__main__": client.create_connector_logs(logs) ``` -### Agent interactions +### Other API interactions -This module also provides a client for agent interactions with Elimity Insights. The snippet below shows how to -authenticate as an agent and list sources at an Elimity Insights server. You can generate a token identifier and +This module also provides a client for other API interactions with Elimity Insights. The snippet below shows how to +authenticate with an API token and list sources at an Elimity Insights server. You can generate a token identifier and secret by visiting the 'API tokens' page in Elimity Insights and clicking the 'CREATE API TOKEN' button. ```python3 -from elimity_insights_client.agent.api import Config, sources +from elimity_insights_client.api import Config, sources if __name__ == "__main__": config = Config(token_id="1", token_secret="my-secret-value", url="https://example.elimity.com", verify_ssl=True) diff --git a/src/elimity_insights_client/agent/__init__.py b/src/elimity_insights_client/agent/__init__.py deleted file mode 100644 index 790c963..0000000 --- a/src/elimity_insights_client/agent/__init__.py +++ /dev/null @@ -1 +0,0 @@ -"""Elimity Insights client for agent interactions.""" diff --git a/src/elimity_insights_client/api/__init__.py b/src/elimity_insights_client/api/__init__.py new file mode 100644 index 0000000..aad8dcd --- /dev/null +++ b/src/elimity_insights_client/api/__init__.py @@ -0,0 +1,4 @@ +"""Elimity Insights client for API interactions.""" +from elimity_insights_client.api._api import Config, query, sources + +__all__ = ["Config", "query", "sources"] diff --git a/src/elimity_insights_client/agent/api.py b/src/elimity_insights_client/api/_api.py similarity index 71% rename from src/elimity_insights_client/agent/api.py rename to src/elimity_insights_client/api/_api.py index f2d8997..705c890 100644 --- a/src/elimity_insights_client/agent/api.py +++ b/src/elimity_insights_client/api/_api.py @@ -1,4 +1,4 @@ -"""API endpoints for agent interactions with an Elimity Insights server.""" +"""Endpoints for API interactions with an Elimity Insights server.""" from dataclasses import dataclass from typing import List, TypeVar, cast, Type, Optional @@ -6,20 +6,20 @@ from requests import request from elimity_insights_client._util import encoder, map_list -from elimity_insights_client.agent._decode_query_results_page import ( +from elimity_insights_client.api._decode_query_results_page import ( decode_query_results_page, QueryResultsPageDict, ) -from elimity_insights_client.agent._decode_source import SourceDict, decode_source -from elimity_insights_client.agent.query import Query -from elimity_insights_client.agent.query_results_page import QueryResultsPage -from elimity_insights_client.agent._encode_query import encode_query -from elimity_insights_client.agent.source import Source +from elimity_insights_client.api._decode_source import SourceDict, decode_source +from elimity_insights_client.api.query import Query +from elimity_insights_client.api.query_results_page import QueryResultsPage +from elimity_insights_client.api._encode_query import encode_query +from elimity_insights_client.api.source import Source @dataclass class Config: - """Configuration consisting of agent credentials and connection properties.""" + """Configuration consisting of API credentials and connection properties.""" token_id: str token_secret: str diff --git a/src/elimity_insights_client/agent/_decode_query_results_page.py b/src/elimity_insights_client/api/_decode_query_results_page.py similarity index 98% rename from src/elimity_insights_client/agent/_decode_query_results_page.py rename to src/elimity_insights_client/api/_decode_query_results_page.py index 61bc1b9..09d3da0 100644 --- a/src/elimity_insights_client/agent/_decode_query_results_page.py +++ b/src/elimity_insights_client/api/_decode_query_results_page.py @@ -4,7 +4,7 @@ from typing_extensions import TypedDict from elimity_insights_client._util import map_list -from elimity_insights_client.agent.query_results_page import ( +from elimity_insights_client.api.query_results_page import ( QueryResultsPage, QueryResult, Entity, diff --git a/src/elimity_insights_client/agent/_decode_source.py b/src/elimity_insights_client/api/_decode_source.py similarity index 96% rename from src/elimity_insights_client/agent/_decode_source.py rename to src/elimity_insights_client/api/_decode_source.py index e46b69e..aeba022 100644 --- a/src/elimity_insights_client/agent/_decode_source.py +++ b/src/elimity_insights_client/api/_decode_source.py @@ -6,7 +6,7 @@ DomainGraphSchemaDict, decode_domain_graph_schema, ) -from elimity_insights_client.agent.source import ( +from elimity_insights_client.api.source import ( Source, LastReloadTimestamp, AbsentLastReloadTimestamp, diff --git a/src/elimity_insights_client/agent/_encode_expression.py b/src/elimity_insights_client/api/_encode_expression.py similarity index 99% rename from src/elimity_insights_client/agent/_encode_expression.py rename to src/elimity_insights_client/api/_encode_expression.py index 83a25cf..961a3aa 100644 --- a/src/elimity_insights_client/agent/_encode_expression.py +++ b/src/elimity_insights_client/api/_encode_expression.py @@ -2,7 +2,7 @@ from typing import List, TypeVar, Callable from elimity_insights_client._util import encode_datetime, local_timezone -from elimity_insights_client.agent.expression import ( +from elimity_insights_client.api.expression import ( BooleanExpression, ActiveBooleanExpression, AllBooleanExpression, diff --git a/src/elimity_insights_client/agent/_encode_query.py b/src/elimity_insights_client/api/_encode_query.py similarity index 98% rename from src/elimity_insights_client/agent/_encode_query.py rename to src/elimity_insights_client/api/_encode_query.py index 3610b25..c887b6a 100644 --- a/src/elimity_insights_client/agent/_encode_query.py +++ b/src/elimity_insights_client/api/_encode_query.py @@ -1,4 +1,4 @@ -from elimity_insights_client.agent._encode_expression import ( +from elimity_insights_client.api._encode_expression import ( encode_boolean_expression, encode_date_expression, encode_date_time_expression, @@ -6,7 +6,7 @@ encode_string_expression, encode_time_expression, ) -from elimity_insights_client.agent.query import ( +from elimity_insights_client.api.query import ( DirectLinkQuery, Ordering, LinkGroupByQuery, diff --git a/src/elimity_insights_client/agent/expression.py b/src/elimity_insights_client/api/expression.py similarity index 100% rename from src/elimity_insights_client/agent/expression.py rename to src/elimity_insights_client/api/expression.py diff --git a/src/elimity_insights_client/agent/query.py b/src/elimity_insights_client/api/query.py similarity index 98% rename from src/elimity_insights_client/agent/query.py rename to src/elimity_insights_client/api/query.py index 603f192..8c738f3 100644 --- a/src/elimity_insights_client/agent/query.py +++ b/src/elimity_insights_client/api/query.py @@ -4,7 +4,7 @@ from enum import Enum, auto from typing import Union, List -from elimity_insights_client.agent.expression import ( +from elimity_insights_client.api.expression import ( BooleanExpression, DateExpression, DateTimeExpression, diff --git a/src/elimity_insights_client/agent/query_results_page.py b/src/elimity_insights_client/api/query_results_page.py similarity index 100% rename from src/elimity_insights_client/agent/query_results_page.py rename to src/elimity_insights_client/api/query_results_page.py diff --git a/src/elimity_insights_client/agent/source.py b/src/elimity_insights_client/api/source.py similarity index 100% rename from src/elimity_insights_client/agent/source.py rename to src/elimity_insights_client/api/source.py diff --git a/tests/elimity_insights_client/agent/__init__.py b/tests/elimity_insights_client/agent/__init__.py deleted file mode 100644 index f3121ed..0000000 --- a/tests/elimity_insights_client/agent/__init__.py +++ /dev/null @@ -1 +0,0 @@ -"""Unit tests for the Elimity Insights agent package.""" diff --git a/tests/elimity_insights_client/api/__init__.py b/tests/elimity_insights_client/api/__init__.py new file mode 100644 index 0000000..6598ca9 --- /dev/null +++ b/tests/elimity_insights_client/api/__init__.py @@ -0,0 +1 @@ +"""Unit tests for the Elimity Insights API package.""" diff --git a/tests/elimity_insights_client/agent/query-results-page.json b/tests/elimity_insights_client/api/query-results-page.json similarity index 100% rename from tests/elimity_insights_client/agent/query-results-page.json rename to tests/elimity_insights_client/api/query-results-page.json diff --git a/tests/elimity_insights_client/agent/schema.json b/tests/elimity_insights_client/api/schema.json similarity index 100% rename from tests/elimity_insights_client/agent/schema.json rename to tests/elimity_insights_client/api/schema.json diff --git a/tests/elimity_insights_client/agent/source.json b/tests/elimity_insights_client/api/source.json similarity index 100% rename from tests/elimity_insights_client/agent/source.json rename to tests/elimity_insights_client/api/source.json diff --git a/tests/elimity_insights_client/agent/test_decode_query_results_page.py b/tests/elimity_insights_client/api/test_decode_query_results_page.py similarity index 89% rename from tests/elimity_insights_client/agent/test_decode_query_results_page.py rename to tests/elimity_insights_client/api/test_decode_query_results_page.py index 63e9463..68eb45c 100644 --- a/tests/elimity_insights_client/agent/test_decode_query_results_page.py +++ b/tests/elimity_insights_client/api/test_decode_query_results_page.py @@ -2,10 +2,10 @@ from json import load from typing import List -from elimity_insights_client.agent._decode_query_results_page import ( +from elimity_insights_client.api._decode_query_results_page import ( decode_query_results_page, ) -from elimity_insights_client.agent.query_results_page import ( +from elimity_insights_client.api.query_results_page import ( Entity, BooleanValue, NumberValue, diff --git a/tests/elimity_insights_client/agent/test_decode_source.py b/tests/elimity_insights_client/api/test_decode_source.py similarity index 87% rename from tests/elimity_insights_client/agent/test_decode_source.py rename to tests/elimity_insights_client/api/test_decode_source.py index d44d7ee..ba8559b 100644 --- a/tests/elimity_insights_client/agent/test_decode_source.py +++ b/tests/elimity_insights_client/api/test_decode_source.py @@ -12,8 +12,8 @@ Type, RelationshipAttributeType, ) -from elimity_insights_client.agent._decode_source import decode_source -from elimity_insights_client.agent.source import Source, PresentLastReloadTimestamp +from elimity_insights_client.api._decode_source import decode_source +from elimity_insights_client.api.source import Source, PresentLastReloadTimestamp def test_decode_source() -> None: diff --git a/tests/elimity_insights_client/agent/test_encode_query.py b/tests/elimity_insights_client/api/test_encode_query.py similarity index 84% rename from tests/elimity_insights_client/agent/test_encode_query.py rename to tests/elimity_insights_client/api/test_encode_query.py index bc645c0..c674bec 100644 --- a/tests/elimity_insights_client/agent/test_encode_query.py +++ b/tests/elimity_insights_client/api/test_encode_query.py @@ -5,8 +5,8 @@ from simplejson import dumps from jsonschema import validate -from elimity_insights_client.agent._encode_query import encode_query -from elimity_insights_client.agent.query import Query +from elimity_insights_client.api._encode_query import encode_query +from elimity_insights_client.api.query import Query _health_checks = [HealthCheck.too_slow]