konecty_sdk_python 2.1.1__py3-none-any.whl

konecty_sdk_python-2.1.1.dist-info/METADATA

@@ -0,0 +1,155 @@
+Metadata-Version: 2.4
+Name: konecty_sdk_python
+Version: 2.1.1
+Summary: Konecty SDK Python
+Author-email: Leonardo Leal <leonardo.leal@konecty.com>, Derotino Silveira <derotino.silveira@konecty.com>
+License: MIT
+Keywords: api,konecty,sdk
+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.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.11
+Requires-Dist: aiohttp>=3.11.11
+Requires-Dist: asyncio>=3.4.3
+Requires-Dist: black>=24.10.0
+Requires-Dist: email-validator>=2.2.0
+Requires-Dist: inquirer>=3.4.0
+Requires-Dist: pydantic>=2.11.4
+Requires-Dist: pymongo>=4.10.1
+Requires-Dist: requests>=2.32.3
+Requires-Dist: rich>=13.9.4
+Requires-Dist: typing-extensions>=4.12.2
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.24.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+## Konecty Python SDK
+
+> 🛠️ Work in progress
+
+This project exposes both:
+
+- a cli for interacting with the database
+- the Konecty client sdk for interacting with Konecty's api
+
+#### Usage
+
+##### Installing on a project
+
+```sh
+uv pip install konecty-sdk-python
+konecty-cli apply --mongo-url="..." --database my-db
+```
+
+##### Running on uvx
+
+```sh
+uvx --from konecty-sdk-python konecty-cli pull --all --mongo-url="..." --database my-db
+```
+
+#### Google login
+
+The Konecty core hosts the whole authorization code flow: your app never talks to Google
+and never sees `client_secret`. The `authId` never travels in a URL — the callback returns
+a single-use code (TTL 60s) and the `authId` only exists in the body of `POST /api/auth/google/session`.
+
+Three steps, three methods:
+
+1. `client.google_login_url(...)` — build the URL to send the browser to (no request is made).
+2. the browser comes back to your `redirect_uri` with `?code=...&state=...` (or `?error=...&state=...`).
+3. `await client.exchange_google_code(code)` — turn the code into a session; the returned
+   `authId` is adopted by the client, so the next calls are authenticated.
+
+```python
+import asyncio
+import os
+import secrets
+
+from KonectySdkPython import KonectyClient
+from KonectySdkPython.lib.exceptions import KonectyAPIError
+
+KONECTY_URL = os.environ["KONECTY_URL"]
+CLIENT_ID = os.environ["KONECTY_CLIENT_ID"]
+REDIRECT_URI = os.environ["KONECTY_REDIRECT_URI"]
+
+
+async def main() -> None:
+    client = KonectyClient(KONECTY_URL)
+
+    # Is Google login enabled for this namespace?
+    options = await client.get_login_options()
+    if not options["googleEnabled"]:
+        raise SystemExit("Google login is disabled for this namespace")
+
+    # Step 1 — send the browser here (state is opaque to Konecty; use it against CSRF).
+    state = secrets.token_urlsafe(16)
+    print(client.google_login_url(client_id=CLIENT_ID, redirect_uri=REDIRECT_URI, state=state))
+
+    # Step 2 — Konecty redirects the browser back to REDIRECT_URI with code + state.
+    #          On refusal it comes back as ?error=<access_denied|provider_error|
+    #          email_not_verified|user_not_found|user_inactive|ambiguous_user>&state=...
+    returned_code = input("code from the callback: ")
+
+    # Step 3 — exchange the single-use code for a session.
+    try:
+        session = await client.exchange_google_code(
+            returned_code,
+            source="my-app",  # optional telemetry: geolocation, resolution, source, fingerprint
+        )
+    except KonectyAPIError as error:
+        raise SystemExit(f"Google login failed: {error}")
+
+    print("logged as", session["user"]["login"], "authId:", client.auth_id)
+
+    # The client is now authenticated: no token needed on the constructor.
+    contacts = await client.find_by_id("User", session["user"]["_id"])
+    print(contacts)
+
+
+asyncio.run(main())
+```
+
+`exchange_google_code` raises `KonectyAPIError` with the message of `errors[0]`
+(`invalid_code`, `expired_code`, `user_not_found`, `user_inactive`) and leaves the client's
+authentication state untouched.
+
+#### Tests
+
+```sh
+uv pip install -e ".[dev]"
+.venv/bin/python -m pytest
+```
+
+#### Build & Publish
+
+Publishing runs from the **Publish** workflow, triggered by hand from the Actions tab
+(`Run workflow`) — no merge publishes on its own. Pick the increment (`patch`, `minor` or
+`major`) and run it; **the version bump is part of publishing**, so there is nothing to edit
+beforehand.
+
+The workflow runs the tests, bumps `version` in [pyproject.toml](./pyproject.toml), builds into
+`dist-build/` and uploads with `uv publish` (secret `PYPI_API_TOKEN`). Only after the upload
+succeeds does it commit `chore(release): <version>` and tag it — a failed upload leaves no bump
+behind claiming a release that does not exist on PyPI.
+
+<details>
+<summary>Publishing manually</summary>
+
+Same PyPI endpoint (`upload.pypi.org/legacy/`) and the same kind of API token. Credentials
+come from `.pypirc`, which is gitignored and therefore local-only — this is why CI
+authenticates through a secret instead.
+
+```sh
+uv build
+uvx twine upload --config-file .pypirc --skip-existing dist/*
+```
+
+Note `--skip-existing`: unlike the workflow, this silently skips versions already published,
+and it is what keeps a stale local `dist/` from re-uploading old artifacts.
+
+</details>

konecty_sdk_python-2.1.1.dist-info/RECORD

@@ -0,0 +1,35 @@
+KonectySdkPython/__init__.py,sha256=E8bSSpoh-XogtSp4oDAhhID0J0UtctOlGS9LhI5F5d0,1022
+KonectySdkPython/cli/__init__.py,sha256=Ap83UThRejLC44VaM-l31NhKcpkzx0Y4CgT042OJCBE,761
+KonectySdkPython/cli/apply.py,sha256=LyPoNcsU3oz9P_eTAi4BdtJHWkbp-sNK_SP9W8Xua04,17923
+KonectySdkPython/cli/backup.py,sha256=rcla3EWfPsy-vWgmDK844EaM5u3h7JF-u7-b2HUBMgA,4785
+KonectySdkPython/cli/pull.py,sha256=n4gIkKtuEpPKULb3zcYu5tZlBLbt_4oNQDeu2l6tHxU,9529
+KonectySdkPython/lib/__init__.py,sha256=Du8jLNfFG1bQuHX5u7pAhbyV9TjC7Ie9K1Xo1KSUqqc,995
+KonectySdkPython/lib/client.py,sha256=i-7goKqsH-jvwxZfGeipTRFByOBAOhMHkuhjjdEN3kE,34034
+KonectySdkPython/lib/exceptions.py,sha256=HR48cd-cptFPoObr37NcvDrdkb-RtxKRteQoG-tuPkk,529
+KonectySdkPython/lib/file_manager.py,sha256=CLpOJWdA1tb2iq0qOIeRyEEIuACRq9tIo7Rls1YT2ig,9986
+KonectySdkPython/lib/filters.py,sha256=PsFaUFCEyKgxgzD566LdTLvuMJevoF_i9U1WnpJZzPQ,4482
+KonectySdkPython/lib/http.py,sha256=atwyuKSFniulvAspi_VhinUhtPJGNyZYkIkaEgqfIqo,3377
+KonectySdkPython/lib/model.py,sha256=8ok1VzPGpXQklz2fJwjP8HT0aKOzhtE93BzcgfVw4zY,2846
+KonectySdkPython/lib/serialization.py,sha256=HxA2t7uPv-4aqkGHMUF8WgP1RcTg6RXsFmr-nUhtx7E,401
+KonectySdkPython/lib/settings.py,sha256=Xbv-KTVM-oxvj-hJQFv2-vbsv4R5aV4D3XWOSdpw6as,5245
+KonectySdkPython/lib/types.py,sha256=Gh8BgoMFug2ixXGs99d3MMFl_JlfRCUdGBLjLAtF_aE,12766
+KonectySdkPython/lib/feature_types/__init__.py,sha256=IooLjxKUkp-uuB8M295FCiKwwrvn7ijp180Q4Lv0Ees,1010
+KonectySdkPython/lib/feature_types/cross_module_query.py,sha256=kG21qBMgCWd2gE1MGRYMvIAQb9ocB-epiKtNJH5t-eQ,2439
+KonectySdkPython/lib/feature_types/kpi.py,sha256=67RpwwwnzU8piIPRyFb6Kn0hqSRpT9RFbYqiRnvYkFk,626
+KonectySdkPython/lib/feature_types/query_json.py,sha256=yZgMPmkMdiBLm-dIrmU1AeZe5G9zQLwLtKUPMb7IOhU,8139
+KonectySdkPython/lib/services/__init__.py,sha256=fluQuxs6LnIZwcjYTuKNeXCFTKuNF3At3X19fIB68p8,121
+KonectySdkPython/lib/services/aggregation.py,sha256=igK1mleMFU2_rDQCAU1yKyvDoOjhTO1SO0Nn4T_DokA,5610
+KonectySdkPython/lib/services/auth.py,sha256=JFiOvk0cqwRucvDQCN93jmKvSITxGtFYW1ME0gdEkMk,4226
+KonectySdkPython/lib/services/base.py,sha256=tdVyWb7Y77cBhVc8Mz2BQMN6kAyZIohoxBxdwDnRsYs,1820
+KonectySdkPython/lib/services/change_user.py,sha256=ce6mcDYMP6eWxW0bEtzlVf7wbppGHCkGwdgo2jJFJOQ,2548
+KonectySdkPython/lib/services/comments.py,sha256=RNevCg4de2FWNk7mD60-pk3r8f2sJ1NLoolD2iNMidg,3033
+KonectySdkPython/lib/services/export.py,sha256=WAtSOUYx4uK1ujGHmITP77B1_l69UykhxvUBXEOG_wE,2074
+KonectySdkPython/lib/services/files.py,sha256=YvaN2yyh48pcPfv0t4PtZLxaDxQlQrGnzIAwnEYN5Ag,1843
+KonectySdkPython/lib/services/notifications.py,sha256=7AtCBbBl-YAz_RBIW6bzoKvuwsYqAUVnLBnS4uAlMWQ,1446
+KonectySdkPython/lib/services/query.py,sha256=vCqbf0QdV8Blh8Hfsvq6Ne1-YFuC5siw1gVa7ZBGs_k,6605
+KonectySdkPython/lib/services/stream.py,sha256=1DMVxcg9Ymk2NgX0Qfvpjrr6vZJo5iFovPFT1NA3_CY,4737
+KonectySdkPython/lib/services/subscriptions.py,sha256=_Jq8jW7YkL_hwLNte1bWgrr4D2EMZUUSOXUgnRoGGK4,1022
+konecty_sdk_python-2.1.1.dist-info/METADATA,sha256=zK3rmKw6vnfQNOLXQWJSjqj5pKmGxOOfmlABHsMeDcs,5442
+konecty_sdk_python-2.1.1.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
+konecty_sdk_python-2.1.1.dist-info/entry_points.txt,sha256=awf962DamFgy791G3PsJ354edBMLJg16Dqi-2Y1tb9s,58
+konecty_sdk_python-2.1.1.dist-info/RECORD,,

konecty_sdk_python-2.1.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.31.0
+Root-Is-Purelib: true
+Tag: py3-none-any

konecty_sdk_python-2.1.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+konecty-cli = KonectySdkPython.cli:main