datalens-sdk 0.1.0__tar.gz

datalens_sdk-0.1.0/.gitignore

@@ -0,0 +1,63 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+
+# Distribution / packaging
+build/
+dist/
+sdist/
+wheels/
+*.egg-info/
+*.egg
+*.egg-link
+pip-wheel-metadata/
+MANIFEST
+
+# Virtual environments
+.venv/
+venv/
+env/
+__pypackages__/
+
+# Tooling caches
+.mypy_cache/
+.dmypy.json
+dmypy.json
+.ruff_cache/
+.pytest_cache/
+.nox/
+.tox/
+.hypothesis/
+
+# Coverage
+.coverage
+.coverage.*
+htmlcov/
+coverage.xml
+*.cover
+
+# Documentation builds
+docs/_build/
+site/
+
+# Secrets / local environment
+.env
+.env.*
+!.env.example
+.envrc
+
+# IDE / editors
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+.sublime-project
+.sublime-workspace
+
+# OS
+.DS_Store
+Thumbs.db
+desktop.ini

datalens_sdk-0.1.0/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## 0.1.0 - 2026-07-29
+
+Initial alpha release of the public DataLens Python SDK:
+
+- Typed clients for Yandex Cloud DataLens and DataLens Enterprise.
+- Typed APIs for connections, datasets, charts, dashboards, collections,
+  workbooks, folders, navigation, and licenses where supported.
+- Generated builders and DTOs backed by the public API specifications.
+- Authentication, transport, serialization, and dashboard export helpers.
+- Action-first deferred raw JSON mutation builders under `client.raw.create`
+  and `client.raw.replace`, kept separate from typed workflows.
+- Runnable resource-creating examples that leave their output in place for inspection.

datalens_sdk-0.1.0/LICENSE

@@ -0,0 +1,215 @@
+Copyright 2026 YANDEX LLC
+
+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.
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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.

datalens_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,256 @@
+Metadata-Version: 2.4
+Name: datalens-sdk
+Version: 0.1.0
+Summary: Python SDK for the DataLens API
+Project-URL: Homepage, https://datalens.ru/
+Project-URL: Documentation, https://github.com/datalens-tech/datalens-sdk#readme
+Project-URL: Repository, https://github.com/datalens-tech/datalens-sdk
+Project-URL: Issues, https://github.com/datalens-tech/datalens-sdk/issues
+Project-URL: Changelog, https://github.com/datalens-tech/datalens-sdk/blob/main/CHANGELOG.md
+Author-email: DataLens Team <datalens-opensource@yandex-team.ru>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: analytics,business-intelligence,datalens,sdk
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+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: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.27
+Requires-Dist: pydantic<3,>=2
+Requires-Dist: pyjwt[crypto]<3,>=2.10
+Requires-Dist: typing-extensions>=4.12
+Description-Content-Type: text/markdown
+
+# DataLens Python SDK
+
+`datalens-sdk` is the typed Python SDK for the [DataLens](https://datalens.ru/promo) API. It provides clients and
+domain models for working with connections, datasets, charts, dashboards, collections, workbooks, folders, and
+navigation in Yandex Cloud DataLens and DataLens Enterprise.
+
+## Requirements
+
+- Python 3.10 or newer
+- A Yandex Cloud organization with DataLens enabled, or a DataLens Enterprise installation
+
+## Project status
+
+The `0.1` series is an alpha release. Until `1.0`, breaking API changes may be
+made in minor releases.
+
+## Installation
+
+The package is available from PyPI:
+
+```bash
+pip install datalens-sdk
+```
+
+## Quick start
+
+`DataLensClientYC` uses the active [`yc` CLI](https://yandex.cloud/en/docs/cli/quickstart) profile by default. Configure
+the organization once; the SDK will then obtain and refresh IAM tokens automatically:
+
+```bash
+yc config set organization-id <organization-id>
+```
+
+Use clients as context managers so their HTTP connections are closed promptly:
+
+```python
+from datalens_sdk import DataLensClientYC
+
+with DataLensClientYC() as client:
+    dataset = client.get.dataset(by_id="<dataset-id>")
+    print(dataset.name)
+```
+
+For DataLens Enterprise, provide the installation's API base URL:
+
+```python
+from datalens_sdk import DataLensClientEnterprise
+
+with DataLensClientEnterprise(base_url="https://datalens.example.com") as client:
+    workbook = client.get.workbook(by_id="<workbook-id>")
+    print(workbook.name)
+```
+
+## Authentication
+
+Yandex Cloud users can choose among the following providers:
+
+- `YCIAMAuthProvider` uses a `yc` CLI profile and refreshes IAM tokens automatically. This is the default for `DataLensClientYC`.
+- `YCServiceAccountCredentialsAuthProvider` exchanges service-account credentials for refreshable IAM tokens.
+- `StaticYCIAMAuthProvider` accepts an existing IAM token and organization ID.
+
+```python
+import os
+
+from datalens_sdk import StaticYCIAMAuthProvider, DataLensClientYC
+
+auth = StaticYCIAMAuthProvider(
+    org_id="<organization-id>",
+    token=os.getenv("_MY_IAM_TOKEN"),
+)
+
+with DataLensClientYC(auth=auth) as client:
+    dashboard = client.get.dashboard(by_id="<dashboard-id>")
+```
+
+Pass `auth=None` explicitly for access without authentication.
+
+## Core concepts
+
+The client groups operations by intent:
+
+- `client.get` loads resources such as datasets, charts, and dashboards.
+- `client.create` exposes typed builders. Configure a builder fluently and call `.build()` to send it.
+- Returned resources provide operations such as `.rename()`, `.update`, and `.delete()`.
+- `EntryLocation` identifies a destination path, workbook, or collection.
+
+For example, create a workbook and use the returned object directly as a destination:
+
+```python
+from datalens_sdk import DataLensClientYC
+
+with DataLensClientYC() as client:
+    workbook = client.create.workbook(name="SDK workbook").build()
+    dataset = client.create.dataset(name="SDK dataset", location=workbook).build()
+```
+
+## Examples
+
+Runnable Yandex Cloud examples are available in [`examples/`](examples/):
+
+| Example | What it demonstrates |
+| --- | --- |
+| [`get_dataset.py`](examples/get_dataset.py) | Load and inspect a dataset |
+| [`collection_workbook_lifecycle.py`](examples/collection_workbook_lifecycle.py) | Collection and workbook create, update, and read |
+| [`clickhouse_dashboard.py`](examples/clickhouse_dashboard.py) | Create a ClickHouse connection, dataset, chart, and dashboard |
+
+Inspect an example's configuration before running it:
+
+```bash
+python examples/clickhouse_dashboard.py --help
+```
+
+Resource-creating examples leave their output in place for inspection.
+
+## Raw JSON artifacts
+
+`to_file(parent)` writes a resource's exact server snapshot below an existing
+parent directory. Artifacts require the resource name and id and use
+`<sanitized name> [<sanitized id>]`; export does not synthesize missing
+identity fields or mutate the resource model.
+
+Raw JSON mutations live under `client.raw`; typed create and update builders
+do not accept raw snapshots. Create from a response snapshot with
+`client.raw.create.<resource>(response_snapshot=raw, name=..., location=...).build()`
+or from an exported artifact directory with
+`client.raw.create.<resource>.from_file(path, name=..., location=...).build()`.
+Replace an existing resource with
+`client.raw.replace.<resource>(target=..., response_snapshot=raw).execute(...)` or
+`client.raw.replace.<resource>.from_file(path, target=...).execute(...)`.
+Dashboard replace requires `publish=` on `execute()`; chart replace can select
+`.mode("save")` or `.mode("publish")` before `execute()`.
+Replace overwrites the supported mutable content and is last-write-wins: it
+does not fetch, merge, or check for concurrent changes. Each `build()` or
+`execute()` call performs a new mutation and has no idempotency guarantee.
+
+`Dashboard.to_file(parent, with_dependencies=True)` adds Charts and Datasets
+discovered only through the relations API. It never calls `getEntries`;
+relation wire types select the specialized Wizard, Editor, or QL getter, and
+relation `workbookId` values are forwarded without forcing a branch or
+revision. The resulting bundle therefore does not promise cross-resource
+revision consistency.
+
+The Dashboard, Charts, and Datasets are validated before the whole bundle is
+published with one atomic no-replace rename. Connections are not included.
+The `charts/` and `datasets/` directories are export-only:
+`client.raw.create.dashboard.from_file(...)` and
+`client.raw.replace.dashboard.from_file(...)` read only `dashboard.json` and
+do not import or remap dependencies.
+
+## Development
+
+The project uses [Nox](https://nox.thea.codes/) for every development check:
+
+```bash
+pip install nox
+
+nox -s check         # complete local PR gate, including every supported Python
+nox                  # same checks as `nox -s check`
+nox -s lint          # Ruff lint
+nox -s format        # format Python and JSON and apply safe lint fixes
+nox -s format-check  # check formatting without modifying files
+nox -s typecheck     # strict mypy
+nox -s dependency-lower-bounds  # verify the dependency versions declared as minimums
+nox -s tests-3.13    # test with a specific supported interpreter
+nox -s update-specs  # update the default public API specification
+```
+
+Pass installation names after `--` to update selected specifications:
+
+```bash
+nox -s update-specs -- yacloud
+nox -s update-specs -- enterprise
+```
+
+Specification updates do not regenerate SDK sources. Review the specification diff, then run `nox -s generate`
+and the complete `nox` gate.
+
+## Maintainer release process
+
+Every stable minor line is published from a protected `release/X.Y` branch.
+Production tags have the exact `vX.Y.Z` form and must point to a commit on the
+matching release branch. The publish workflow rejects a tag from any other
+branch, runs the complete quality and Python-version matrix, builds and
+validates one wheel and sdist, publishes those exact files, and attaches them
+to the GitHub Release.
+
+To start a new minor line:
+
+1. Open a release PR against `main` that sets the final version and adds its
+   dated changelog section.
+2. Merge the PR after every required check passes.
+3. Create `release/X.Y` from that merge commit and wait for the release-branch
+   CI run to pass.
+4. Create and push an annotated `vX.Y.Z` tag at that commit.
+5. Approve the `pypi` deployment, then verify the published metadata,
+   provenance, hashes, installation, and a read-only call.
+
+For a patch on an older line, fix the defect on `main` first when it still
+applies there. Open a PR against `release/X.Y` using `git cherry-pick -x`,
+adapt the change if that line has diverged, update the patch version and
+changelog, and tag the merged release-branch commit. A fix that no longer
+applies to `main` may target only the release branch with the reason recorded
+in the PR.
+
+TestPyPI is separate: manually run the `Publish` workflow from `main`. It
+executes the same complete verification and build path but requires approval
+of the `testpypi` environment and does not create a tag or GitHub Release.
+
+Tags and published files are immutable. If a release is unusable, yank it
+where supported and publish a new patch version. Repository rulesets,
+deployment environments, and trusted publishers are configured outside the
+source tree by repository administrators.
+
+## Project policies
+
+- Read [CONTRIBUTING.md](CONTRIBUTING.md) before opening a pull request.
+- Report vulnerabilities privately according to [SECURITY.md](SECURITY.md).
+- Participation is governed by [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).
+- User-visible changes are recorded in [CHANGELOG.md](CHANGELOG.md).
+
+For general project questions, use
+[GitHub Issues](https://github.com/datalens-tech/datalens-sdk/issues).
+
+## License
+
+Licensed under the Apache License 2.0. See [LICENSE](LICENSE).