cognee-connectors-core 0.1.0__tar.gz

cognee_connectors_core-0.1.0/.gitignore

@@ -0,0 +1,111 @@
+# Environment files: .env.template is tracked, real credentials never are.
+.env
+.env.local
+.local.env
+.prod.env
+
+# cognee data written by local runs and the tests
+.data
+.data_storage/
+.cognee_system/
+.cognee_cache/
+.cognee/
+*.lance/
+logs/
+
+# Test output files
+test_outputs/
+.artifacts/
+.anon_id
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# Environments (uv). `.venv-clean` is the cognee-free venv of the clean-install check.
+# `.python-version` is tracked on purpose: it pins the interpreter uv picks.
+.venv
+.venv-*
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+mise.toml
+
+# Ruff
+.ruff_cache/
+
+# mypy / ty
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# PyCharm / VS Code
+.idea/
+.vscode/
+
+# OS
+.DS_Store
+
+# enola code-graph snapshots (written into any repository enola scans)
+.enola/
+
+# PyPI configuration
+.pypirc
+
+node_modules/

cognee_connectors_core-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 Topoteretes UG
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

cognee_connectors_core-0.1.0/PKG-INFO

@@ -0,0 +1,233 @@
+Metadata-Version: 2.5
+Name: cognee-connectors-core
+Version: 0.1.0
+Summary: The contract every cognee connector implements: OAuth2 descriptors, webhook verification, DLT conventions and the registry hosts load connectors through.
+Project-URL: Homepage, https://github.com/topoteretes/cognee/tree/main/cognee-connectors/core
+Project-URL: Repository, https://github.com/topoteretes/cognee
+Project-URL: Issues, https://github.com/topoteretes/cognee/issues
+Project-URL: Documentation, https://docs.cognee.ai
+Author: Cognee team
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: ai-memory,cognee,connector,dlt,oauth2,webhooks
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: <3.15,>=3.10
+Requires-Dist: aiohttp<4.0.0,>=3.13.5
+Requires-Dist: pydantic-settings!=2.12.*,!=2.13.*,!=2.14.0,!=2.14.1,<3,>=2.7.0
+Provides-Extra: dlt
+Requires-Dist: dlt<1.31,>=1.9.0; extra == 'dlt'
+Description-Content-Type: text/markdown
+
+# cognee-connectors-core
+
+The contract every cognee connector implements, with no host in it. A connector
+package (`cognee-connector-<provider>`) depends on this package and on its vendor
+SDK; the hosts — cognee's own server and SDK, cloud-backend — depend on it to find
+and drive the connectors. `cognee` itself is never a runtime dependency of this
+package: everything here imports with cognee absent.
+
+```bash
+pip install cognee-connectors-core          # the contract
+pip install "cognee-connectors-core[dlt]"   # plus the dlt range connectors with a DLT source pin
+```
+
+Python 3.10 – 3.14. Apache-2.0.
+
+## Modules
+
+| Module | What it owns |
+| --- | --- |
+| `cognee_connectors_core.base` | `Connector` (the abstract contract), `ConnectorInstallation`, `SyncScope`, `ConnectorResource`, `WebhookDispatch`, `RefreshedTokens`, `WebhookVerifier`, the `Credential` protocol, `account_slug`, `dataset_name_for` |
+| `cognee_connectors_core.descriptor` | `ConnectorDescriptor`, a Tier 1 connector expressed as data, plus `resolve_path` and `payload_paths` |
+| `cognee_connectors_core.oauth2` | `DescriptorConnector`, which turns a descriptor into a working connector: authorize URL, code exchange, installation parsing, refresh, webhook verification and handling, and the `resolve_account` hook for Tier 2 |
+| `cognee_connectors_core.signatures` | The webhook HMAC schemes (`SHA256_PREFIX`, `BARE_HEX`, `SLACK_V0`, `TIMESTAMPED`) and `HmacVerifier` |
+| `cognee_connectors_core.oauth_state` | Provider-agnostic OAuth `state` minting and validation (`make_state`, `validate_state`) |
+| `cognee_connectors_core.settings` | `ConnectorSettings`, the pydantic-settings base every provider settings class subclasses, and `require` |
+| `cognee_connectors_core.dlt_conventions` | The attribute and column names cognee's ingestion reads off a DLT source (`cognee_document_source`, `cognee_pipeline_scope`, `cognee_node_set`, `cognee_structure`) and the helpers around them |
+| `cognee_connectors_core.registry` | `use_connector`, `get_connector`, `find_connector`, `catalog()` and the entry-point loaders |
+| `cognee_connectors_core.http` | The two-method `HttpClient` protocol and its aiohttp default |
+| `cognee_connectors_core.errors` | `ConnectorError`, `WebhookVerificationError`, `RateLimitedError` |
+| `cognee_connectors_core.testing` | `FakeHttpClient`, `FakeSettings`, `FakeCredential`, `sign_body`, `webhook_headers` |
+
+The design, the three tiers and the rules every package follows are in
+[`docs/ARCHITECTURE.md`](../docs/ARCHITECTURE.md) at the repo root.
+
+## How a host uses the loaders
+
+Connector packages advertise themselves through three entry-point groups; a host
+never imports a provider by name.
+
+```python
+from cognee_connectors_core import registry
+
+# Group "cognee.connectors": {provider: Connector}, each one registered.
+connectors = registry.load_connectors()
+# Group "cognee.sources": {name: source factory}; nothing is called.
+sources = registry.load_sources()
+# Group "cognee.integrations": calls each package's register(); the names that ran.
+registered = registry.load_host_registrations()
+
+# KeyError for an unknown provider, which a host answers with 404.
+connector = registry.get_connector("notion")
+# provider, display_name, auth, tier, has_webhooks, supports_resource_selection, ...
+for entry in registry.catalog():
+    print(entry["provider"], entry["auth"], entry["has_webhooks"])
+```
+
+Each entry point is loaded on its own: a package that fails to import is logged
+and skipped, so one broken connector cannot hide the others. A host that already
+knows its connectors registers them directly with `registry.use_connector(CONNECTOR)`.
+
+The host owns everything the contract leaves out: credential storage and
+encryption, the OAuth routes (minting `state` with `oauth_state.make_state` and
+checking it with `validate_state`), webhook delivery dedupe (claim
+`WebhookDispatch.delivery_id`, or `connector.webhook_delivery_key(body, headers)`
+before calling `handle_webhook`), and running a sync. Token material reaches a
+connector only as the decrypted `tokens` mapping the host passes in.
+
+## How a connector author uses `DescriptorConnector`
+
+A Tier 1 provider is a descriptor, a settings class and nothing else:
+
+```python
+from pydantic_settings import SettingsConfigDict
+
+from cognee_connectors_core import (
+    ConnectorDescriptor,
+    ConnectorSettings,
+    DescriptorConnector,
+    SignatureScheme,
+)
+
+
+class LinearSettings(ConnectorSettings):
+    model_config = SettingsConfigDict(env_prefix="LINEAR_", extra="ignore")
+    webhook_secret: str = ""  # LINEAR_WEBHOOK_SECRET
+
+
+DESCRIPTOR = ConnectorDescriptor(
+    provider="linear",
+    display_name="Linear",
+    authorize_url="https://linear.app/oauth/authorize",
+    token_url="https://api.linear.app/oauth/token",
+    scopes="read",
+    authorize_params=(("response_type", "code"), ("actor", "app")),
+    account_id_path="organization.id",
+    account_label_path="organization.name",
+    signature_scheme=SignatureScheme.BARE_HEX,
+    signature_header="linear-signature",
+    webhook_account_id_path="organizationId",
+    webhook_delivery_id_path="webhookId",
+)
+
+CONNECTOR = DescriptorConnector(DESCRIPTOR, LinearSettings())
+```
+
+`DescriptorConnector` then implements the whole `Connector` contract:
+`authorize_url(state)`, `exchange_callback(code, params)`,
+`parse_installation(account_data)`, `refresh(credential, tokens)`,
+`webhook_verifier()`, `handle_webhook(raw_body, headers)`,
+`webhook_delivery_key(raw_body, headers)`, `sync_scope(credential, tokens,
+resources=...)`, `dataset_name(credential)`, polling and `content_type`.
+Settings are read at call time, so a value rotated on the settings object takes
+effect on the next request; a missing one raises `RuntimeError` naming the
+environment variable (`LINEAR_CLIENT_ID is not configured`).
+
+A Tier 2 provider, whose token response does not say which account authorized,
+subclasses it and overrides one hook:
+
+```python
+class LinearConnector(DescriptorConnector):
+    async def resolve_account(self, token_response):
+        status, body = await self.http.get_json(
+            "https://api.linear.app/graphql?query=...",
+            {"Authorization": f"Bearer {token_response['access_token']}"},
+        )
+        # Merged over the token response; account_id_path then reads organization.id.
+        return {"organization": body["data"]["viewer"]["organization"]}
+```
+
+An API-key or local provider is a descriptor with `auth="api_key"` or
+`auth="local"`; the OAuth fields may stay empty and the OAuth members raise
+`NotImplementedError`, while the provider still has a name, a dataset, a
+content type and a catalog entry. A provider whose auth model is not OAuth2 at all
+(GitHub Apps) subclasses `Connector` directly.
+
+Webhook verification is a scheme, not code: `HmacVerifier` verifies over the raw
+bytes, in constant time, and refuses with `WebhookVerificationError` carrying the
+status a host should answer with (`401`, `413` over `MAX_BODY_BYTES`). Header
+names are matched case-insensitively.
+
+### Testing a connector
+
+```python
+from cognee_connectors_core.testing import FakeHttpClient, FakeSettings, webhook_headers
+
+token_response = {"access_token": "tok", "organization": {"id": "org-1"}}
+http = FakeHttpClient({("POST", DESCRIPTOR.token_url): (200, token_response)})
+connector = DescriptorConnector(DESCRIPTOR, FakeSettings(webhook_secret="s3"), http)
+
+account_data = await connector.exchange_callback("code", {})
+installation = connector.parse_installation(account_data)
+assert installation.provider_account_id == "org-1"
+assert http.last_call.data["grant_type"] == "authorization_code"
+
+body = b'{"organizationId": "org-1", "webhookId": "d1"}'
+headers = webhook_headers(DESCRIPTOR, "s3", body)
+verified = await connector.webhook_verifier().verify(body, headers)
+dispatch = await connector.handle_webhook(verified, {})
+assert dispatch.provider_account_id == "org-1" and dispatch.delivery_id == "d1"
+```
+
+## DLT conventions
+
+A DLT source opts into cognee's document ingestion by setting the attributes
+named in `dlt_conventions` (`DOCUMENT_SOURCE_ATTR`, `PIPELINE_SCOPE_ATTR`) and
+by writing the `NODE_SET_COLUMN` / `STRUCTURE_COLUMN` columns with
+`DOCUMENT_COLUMN_HINTS`. The values are byte-identical to cognee's
+`cognee.tasks.ingestion.dlt_utils`; connectors import them from here so no
+package needs cognee at runtime.
+
+One value is a version, not a name. `DOCUMENT_SYNC_VERSION` is the protocol
+version cognee's ingestion implements and it moves with cognee releases; the
+copy here is the version this package was cut at. A source that needs a
+capability (per-row node sets from version 2, structure from version 3) gates
+on the **host's** value, never on the constant:
+
+```python
+from cognee_connectors_core.dlt_conventions import require_document_sync_version
+
+# At the top of the source factory, before any provider call.
+require_document_sync_version(3, provider="Notion", feature="reads per-row node sets and structure")
+```
+
+`host_document_sync_version()` is what it reads: the installed cognee's value,
+`0` for a cognee without DLT document ingestion, and this package's own value
+only when cognee is not installed at all (nothing can ingest then, and a
+connector's tests run without it).
+
+## Development
+
+From the repo root, with a Python that has pytest and pytest-asyncio:
+
+```bash
+PYTHONPATH=core python -m pytest core/tests -q
+ruff check core && ruff format --check core
+```
+
+The suite is pure: no network, no database, no cognee. One test compares the
+DLT conventions against cognee's own module when cognee happens to be
+importable, and skips otherwise.