entryscape 1.3.0__py3-none-any.whl

entryscape/__init__.py

@@ -0,0 +1,219 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+EntryScape API
+
+This API provides structured access to EntryScape data following DCAT-AP standards. All entity endpoints follow a consistent pattern: - GET /{entity} - List all entities - POST /{entity} - Create a new entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id} - Get entity reference info - DELETE /{entity}/{context_id}/{entry_id} - Delete an entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id}/metadata - Get raw RDF metadata - PUT /{entity}/{context_id}/{entry_id}/metadata - Replace raw RDF metadata (JSON-LD, Turtle, RDF/XML, or N-Triples passthrough)  ## Reading and consistency  Reads of a single entity — `GET /{entity}/{context_id}/{entry_id}` and its `/metadata` — go straight to the store and always reflect the latest write.  Lists and search do not. They are answered from a search index that is updated asynchronously, so for a short interval after a write:  - an entry that was just created may be missing from the list it belongs to,   while reading it by id already works; - an entry that was just deleted may still appear; - `results` counts what the index holds, not what the store holds.  Write a client that tolerates this: after creating an entry, use the id the create returned rather than searching for what you just wrote. `results` is also an upper bound rather than an exact count when the caller cannot read every hit (see the field's own description).  Separately, responses are cached for 15 minutes by default, which is a second and unrelated source of staleness. A write invalidates the cache entries it affects, but a read that lands in the indexing gap can cache a list that does not yet show it.  ## Authentication  Most endpoints require an authenticated session. Reading public data works without authentication, while creating, updating, and deleting entities requires a valid user session.  1. **Log in** with `POST /auth/login`, supplying an EntryStore username and    password. The response returns an `auth_token`. 2. **Send the token** on subsequent requests via the `X-Auth-Token` header.    This is the recommended method for SDK and programmatic access. Browser    clients can instead rely on the `auth_token` cookie, which the server sets    automatically on login (`SameSite=Lax; Secure`). 3. **Inspect the session** with `GET /auth/whoami`, which returns the current    user or an anonymous/guest identity when no valid token is supplied. 4. **Log out** with `POST /auth/logout` to invalidate the token and clear the    cookie.  ### Writes and CSRF  Send the token as the `X-Auth-Token` **header** and there is nothing else to do: creates, updates and deletes work as they are, which is how the SDKs and the MCP server are built.  The `auth_token` cookie is different. A cookie is attached by the browser automatically, so a state-changing request authenticated by it alone is what cross-site request forgery abuses, and those requests additionally need a double-submit token: read the `XSRF-TOKEN` cookie the server sets on any response and send its value back as the `X-XSRF-TOKEN` header. Without it the request is rejected with `403` before it reaches the endpoint.  A custom header cannot be forged this way — cross-origin JavaScript cannot set one without a CORS preflight, which this API grants only to configured origins — so the header is the recommended path for anything that is not a browser session.  ### App Tokens  An app token identifies an integration. Create one with `POST /app-token` (unauthenticated). Creation requires an email address: the token starts in the `pending` state and a 6-digit code is emailed to the owner. Confirm the code with `POST /app-token/verify` to activate the token and receive its value, which is shown only once — store it securely. `GET /app-token/{app_token_id}` then returns its details and quota usage, authenticated by the token itself via the `X-App-Token` header.  **The `X-App-Token` header is accepted only by `GET /app-token/{app_token_id}`.** No other operation reads it, and the read quota is recorded but not yet enforced: reading public data needs no token of any kind, and sending an app token with a read neither grants nor meters anything. Metered public read access is the intent of the two-token model, not a description of this release — see the `security` declared on each operation for what it actually accepts.  ## SDKs  Generated clients for Python, TypeScript, JavaScript and C# wrap every operation below, and each operation on this page shows the SDK call beside the `curl` command. Two of them install from a public registry:  ``` pip install entryscape                 # Python npm install @entryscape/api-client     # TypeScript and JavaScript ```  `@entryscape/api-client` ships an ESM and a CommonJS build, so `import` and `require()` both work and TypeScript is not required to use it — the name describes what it is written in, not what you have to write. There is a separate generated JavaScript SDK, and it is deliberately **not** on npm; this package is the npm client for both languages.  Every SDK, including the C# and JavaScript ones, is also published as a tarball. The downloads are linked in the sidebar, they are the route to take when a registry is unreachable or a build has to vendor its dependencies, and each archive carries the SDK's own README:  - **Python** — `pip install entryscape`, or `python-sdk.tar.gz`. - **TypeScript and JavaScript** — `npm install @entryscape/api-client`, or   `typescript-sdk.tar.gz`. - **JavaScript (the separate generated client)** — not published to a   registry, by design; `javascript-sdk.tar.gz` only. - **C#** — not published to NuGet yet; `csharp-sdk.tar.gz` only. - **MCP server** — `npx -y @entryscape/mcp-server`, or `mcp-server.tar.gz`.  ## MCP Server  A Model Context Protocol (MCP) server is generated from this specification and published alongside the SDKs (`@entryscape/mcp-server`), exposing the API as tools for AI assistants and agents. Each operation becomes one tool named after its `operationId` — `listDatasets`, `createCatalog`, `search`, `getJobStatus`. The `auth` operations are the exception: the server reads its token once at startup, so a `login` tool could install nothing and a `logout` tool would only invalidate the token the server was started with. On connect the server also hands the assistant a short set of rules that hold across every tool: a token is bound to one EntryStore instance, the search index lags a write, uploads finish as jobs.  ### Install  The server is on npm, and MCP servers are normally launched straight from there, so nothing has to be installed first:  ``` npx -y @entryscape/mcp-server ```  `npm install -g @entryscape/mcp-server` works too and puts an `entryscape-mcp` binary on `PATH`. It is also listed in the MCP Registry as `com.entryscape/mcp-server`, which is where clients and marketplaces look it up.  Without npm, download `mcp-server.tar.gz` from the SDK downloads and unpack it. The package ships prebuilt; install its runtime dependency once:  ``` mkdir entryscape-mcp && tar -xzf mcp-server.tar.gz -C entryscape-mcp cd entryscape-mcp && npm install --omit=dev ```  ### Configure  The server is a stdio MCP server configured through environment variables, read once at startup:  - `ENTRYSCAPE_API_URL` — base URL of the API server, path included. Required:   there is no default, and the server refuses to start without it. - `ENTRYSCAPE_AUTH_TOKEN` — a session token from `POST /auth/login`, sent as   the `X-Auth-Token` header. Optional: without it reads see public entries and   every write is refused. A token is valid only for the EntryStore instance   that issued it. - `ENTRYSCAPE_ENTRYSTORE_HOST` — the EntryStore instance the API server should   use, for example `dev.entryscape.com/store/`. Unset means the API server's   own default. - `ENTRYSCAPE_MCP_UPLOAD_ROOT` — the directory the upload tools may read files   from. **Unset means uploads are disabled**: `addFileToDistribution`,   `replaceFileInDistribution` and `importTerminology` refuse and say so. - `ENTRYSCAPE_MCP_TAGS` — comma-separated tags to serve tools for, for example   `catalog,dataset,distribution,search`. Unset serves every tool.  The package's `README.md` lists the remaining variables (timeouts and size caps). Register the server with any MCP-capable client by adding it to the client's `mcpServers` configuration:  ```json {   \"mcpServers\": {     \"entryscape\": {       \"command\": \"npx\",       \"args\": [\"-y\", \"@entryscape/mcp-server\"],       \"env\": {         \"ENTRYSCAPE_API_URL\": \"https://<your EntryScape API host>\",         \"ENTRYSCAPE_AUTH_TOKEN\": \"your-session-token\"       }     }   } } ```  From an unpacked download instead, the command is `\"command\": \"node\", \"args\": [\"/path/to/entryscape-mcp/dist/bin/entryscape-mcp.js\"]`.  ### Claude Code  The unpacked package is also a Claude Code plugin, so one install gives the server and the skills below together. Claude Code installs plugins from marketplaces, and the package carries a one-entry marketplace pointing at itself:  ``` claude plugin marketplace add /path/to/entryscape-mcp claude plugin install entryscape@entryscape --scope user ```  The plugin passes `ENTRYSCAPE_API_URL`, `ENTRYSCAPE_AUTH_TOKEN`, `ENTRYSCAPE_ENTRYSTORE_HOST`, `ENTRYSCAPE_MCP_TAGS` and `ENTRYSCAPE_MCP_UPLOAD_ROOT` through from the shell Claude Code was started in, so set them there. To try the plugin for one session without installing it, start Claude Code with `--plugin-dir /path/to/entryscape-mcp`.  ### Skills  `skills/` in the package holds procedures that span several tools, in the Agent Skills format (a `SKILL.md` with `name` and `description`): which tools to call in which order, what to check between calls, and where to stop. Claude Code loads them from the plugin; other clients that read the format can be pointed at the directory. The `find` skill covers discovery, facets and selective metadata reads; `publish-dataset` takes a dataset from catalog to validated distribution with its file; `edit-metadata` changes an entry that already exists without dropping the rest of its graph, models included; `migrate-from-taskrunner` moves an integration off the deprecated Taskrunner API. Every tool a skill names is checked against this specification when the package is built.  ## Deprecation Policy  When endpoints or features are deprecated: 1. The operation is marked with `deprecated: true` in this spec 2. The operation description documents the replacement endpoint and sunset date 3. Deprecated endpoints remain functional for at least 6 months after announcement 4. The server returns a `Sunset` header with the planned removal date 5. After the sunset date, the endpoint may be removed in a future release
+
+The version of the OpenAPI document: 1.3.0
+Contact: contact@entryscape.com
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+__version__ = "1.3.0"
+
+# Define package exports
+__all__ = [
+    "AppTokenApi",
+    "AuthApi",
+    "CatalogApi",
+    "ContactApi",
+    "DataserviceApi",
+    "DatasetApi",
+    "DistributionApi",
+    "DocumentApi",
+    "IdeaApi",
+    "JobApi",
+    "ModelApi",
+    "ModelClassApi",
+    "ModelDiagramApi",
+    "ModelFieldApi",
+    "ModelFormApi",
+    "ModelNamespaceApi",
+    "ModelPropertyApi",
+    "OrganizationApi",
+    "SearchApi",
+    "ShowcaseApi",
+    "SuggestionApi",
+    "TerminologyApi",
+    "UploadApi",
+    "ApiResponse",
+    "ApiClient",
+    "Configuration",
+    "OpenApiException",
+    "ApiTypeError",
+    "ApiValueError",
+    "ApiKeyError",
+    "ApiAttributeError",
+    "ApiException",
+    "AppToken",
+    "AppTokenCreateRequest",
+    "AppTokenCreateResponse",
+    "AppTokenStatus",
+    "AppTokenVerifyRequest",
+    "EntityListItem",
+    "EntityListResponse",
+    "EntityReference",
+    "EntityType",
+    "Error",
+    "FacetField",
+    "FacetFieldValuesInner",
+    "FacetList",
+    "FacetListAvailableInner",
+    "JobResponse",
+    "JobStatus",
+    "JobStatusProgress",
+    "JobStatusValue",
+    "JobType",
+    "ListCatalogsEntryTypeParameter",
+    "ListCatalogsGraphTypeParameter",
+    "ListCatalogsResourceTypeParameter",
+    "LoginRequest",
+    "LoginResponse",
+    "MetadataFormat",
+    "MetadataRequest",
+    "ParentReference",
+    "SearchRequest",
+    "SearchRequestFilters",
+    "SearchRequestFiltersGraphType",
+    "SearchRequestFiltersResourceType",
+    "SearchRequestSort",
+    "SearchRequestSortOrder",
+    "SearchResponse",
+    "SearchResult",
+    "SearchResultGraphType",
+    "SearchResultResourceType",
+    "SearchSortOrderParameter",
+    "TerminologyImportMode",
+    "ValidationProfile",
+    "ValidationResponse",
+    "ValidationResult",
+    "ValidationSeverity",
+    "ValidationSummary",
+    "WhoamiResponse",
+]
+
+# import apis into sdk package
+from entryscape.api.app_token_api import AppTokenApi as AppTokenApi
+from entryscape.api.auth_api import AuthApi as AuthApi
+from entryscape.api.catalog_api import CatalogApi as CatalogApi
+from entryscape.api.contact_api import ContactApi as ContactApi
+from entryscape.api.dataservice_api import DataserviceApi as DataserviceApi
+from entryscape.api.dataset_api import DatasetApi as DatasetApi
+from entryscape.api.distribution_api import DistributionApi as DistributionApi
+from entryscape.api.document_api import DocumentApi as DocumentApi
+from entryscape.api.idea_api import IdeaApi as IdeaApi
+from entryscape.api.job_api import JobApi as JobApi
+from entryscape.api.model_api import ModelApi as ModelApi
+from entryscape.api.model_class_api import ModelClassApi as ModelClassApi
+from entryscape.api.model_diagram_api import ModelDiagramApi as ModelDiagramApi
+from entryscape.api.model_field_api import ModelFieldApi as ModelFieldApi
+from entryscape.api.model_form_api import ModelFormApi as ModelFormApi
+from entryscape.api.model_namespace_api import ModelNamespaceApi as ModelNamespaceApi
+from entryscape.api.model_property_api import ModelPropertyApi as ModelPropertyApi
+from entryscape.api.organization_api import OrganizationApi as OrganizationApi
+from entryscape.api.search_api import SearchApi as SearchApi
+from entryscape.api.showcase_api import ShowcaseApi as ShowcaseApi
+from entryscape.api.suggestion_api import SuggestionApi as SuggestionApi
+from entryscape.api.terminology_api import TerminologyApi as TerminologyApi
+from entryscape.api.upload_api import UploadApi as UploadApi
+
+# import ApiClient
+from entryscape.api_response import ApiResponse as ApiResponse
+from entryscape.api_client import ApiClient as ApiClient
+from entryscape.configuration import Configuration as Configuration
+from entryscape.exceptions import OpenApiException as OpenApiException
+from entryscape.exceptions import ApiTypeError as ApiTypeError
+from entryscape.exceptions import ApiValueError as ApiValueError
+from entryscape.exceptions import ApiKeyError as ApiKeyError
+from entryscape.exceptions import ApiAttributeError as ApiAttributeError
+from entryscape.exceptions import ApiException as ApiException
+
+# import models into sdk package
+from entryscape.models.app_token import AppToken as AppToken
+from entryscape.models.app_token_create_request import (
+    AppTokenCreateRequest as AppTokenCreateRequest,
+)
+from entryscape.models.app_token_create_response import (
+    AppTokenCreateResponse as AppTokenCreateResponse,
+)
+from entryscape.models.app_token_status import AppTokenStatus as AppTokenStatus
+from entryscape.models.app_token_verify_request import (
+    AppTokenVerifyRequest as AppTokenVerifyRequest,
+)
+from entryscape.models.entity_list_item import EntityListItem as EntityListItem
+from entryscape.models.entity_list_response import (
+    EntityListResponse as EntityListResponse,
+)
+from entryscape.models.entity_reference import EntityReference as EntityReference
+from entryscape.models.entity_type import EntityType as EntityType
+from entryscape.models.error import Error as Error
+from entryscape.models.facet_field import FacetField as FacetField
+from entryscape.models.facet_field_values_inner import (
+    FacetFieldValuesInner as FacetFieldValuesInner,
+)
+from entryscape.models.facet_list import FacetList as FacetList
+from entryscape.models.facet_list_available_inner import (
+    FacetListAvailableInner as FacetListAvailableInner,
+)
+from entryscape.models.job_response import JobResponse as JobResponse
+from entryscape.models.job_status import JobStatus as JobStatus
+from entryscape.models.job_status_progress import JobStatusProgress as JobStatusProgress
+from entryscape.models.job_status_value import JobStatusValue as JobStatusValue
+from entryscape.models.job_type import JobType as JobType
+from entryscape.models.list_catalogs_entry_type_parameter import (
+    ListCatalogsEntryTypeParameter as ListCatalogsEntryTypeParameter,
+)
+from entryscape.models.list_catalogs_graph_type_parameter import (
+    ListCatalogsGraphTypeParameter as ListCatalogsGraphTypeParameter,
+)
+from entryscape.models.list_catalogs_resource_type_parameter import (
+    ListCatalogsResourceTypeParameter as ListCatalogsResourceTypeParameter,
+)
+from entryscape.models.login_request import LoginRequest as LoginRequest
+from entryscape.models.login_response import LoginResponse as LoginResponse
+from entryscape.models.metadata_format import MetadataFormat as MetadataFormat
+from entryscape.models.metadata_request import MetadataRequest as MetadataRequest
+from entryscape.models.parent_reference import ParentReference as ParentReference
+from entryscape.models.search_request import SearchRequest as SearchRequest
+from entryscape.models.search_request_filters import (
+    SearchRequestFilters as SearchRequestFilters,
+)
+from entryscape.models.search_request_filters_graph_type import (
+    SearchRequestFiltersGraphType as SearchRequestFiltersGraphType,
+)
+from entryscape.models.search_request_filters_resource_type import (
+    SearchRequestFiltersResourceType as SearchRequestFiltersResourceType,
+)
+from entryscape.models.search_request_sort import SearchRequestSort as SearchRequestSort
+from entryscape.models.search_request_sort_order import (
+    SearchRequestSortOrder as SearchRequestSortOrder,
+)
+from entryscape.models.search_response import SearchResponse as SearchResponse
+from entryscape.models.search_result import SearchResult as SearchResult
+from entryscape.models.search_result_graph_type import (
+    SearchResultGraphType as SearchResultGraphType,
+)
+from entryscape.models.search_result_resource_type import (
+    SearchResultResourceType as SearchResultResourceType,
+)
+from entryscape.models.search_sort_order_parameter import (
+    SearchSortOrderParameter as SearchSortOrderParameter,
+)
+from entryscape.models.terminology_import_mode import (
+    TerminologyImportMode as TerminologyImportMode,
+)
+from entryscape.models.validation_profile import ValidationProfile as ValidationProfile
+from entryscape.models.validation_response import (
+    ValidationResponse as ValidationResponse,
+)
+from entryscape.models.validation_result import ValidationResult as ValidationResult
+from entryscape.models.validation_severity import (
+    ValidationSeverity as ValidationSeverity,
+)
+from entryscape.models.validation_summary import ValidationSummary as ValidationSummary
+from entryscape.models.whoami_response import WhoamiResponse as WhoamiResponse

entryscape/api/__init__.py

@@ -0,0 +1,26 @@
+# flake8: noqa
+
+# import apis into api package
+from entryscape.api.app_token_api import AppTokenApi
+from entryscape.api.auth_api import AuthApi
+from entryscape.api.catalog_api import CatalogApi
+from entryscape.api.contact_api import ContactApi
+from entryscape.api.dataservice_api import DataserviceApi
+from entryscape.api.dataset_api import DatasetApi
+from entryscape.api.distribution_api import DistributionApi
+from entryscape.api.document_api import DocumentApi
+from entryscape.api.idea_api import IdeaApi
+from entryscape.api.job_api import JobApi
+from entryscape.api.model_api import ModelApi
+from entryscape.api.model_class_api import ModelClassApi
+from entryscape.api.model_diagram_api import ModelDiagramApi
+from entryscape.api.model_field_api import ModelFieldApi
+from entryscape.api.model_form_api import ModelFormApi
+from entryscape.api.model_namespace_api import ModelNamespaceApi
+from entryscape.api.model_property_api import ModelPropertyApi
+from entryscape.api.organization_api import OrganizationApi
+from entryscape.api.search_api import SearchApi
+from entryscape.api.showcase_api import ShowcaseApi
+from entryscape.api.suggestion_api import SuggestionApi
+from entryscape.api.terminology_api import TerminologyApi
+from entryscape.api.upload_api import UploadApi