filament-py 0.1.0__tar.gz

filament_py-0.1.0/.gitignore

@@ -0,0 +1,4 @@
+.venv/
+dist/
+__pycache__/
+*.py[cod]

filament_py-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 2026- Intergalactic Data Labs, Inc.
+
+   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.

filament_py-0.1.0/PKG-INFO

@@ -0,0 +1,279 @@
+Metadata-Version: 2.5
+Name: filament-py
+Version: 0.1.0
+Summary: Generated Python client for the Filament API
+Project-URL: Repository, https://github.com/galaxy-io/filament
+Project-URL: Issues, https://github.com/galaxy-io/filament/issues
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: anyio<5,>=4
+Requires-Dist: httpx<1,>=0.28
+Requires-Dist: pydantic<3,>=2.8
+Requires-Dist: typing-extensions<5,>=4.10
+Description-Content-Type: text/markdown
+
+# Filament Python SDK
+
+Create connections, discover resources, build pipelines, and run them from Python.
+
+- **Package:** `filament-py`
+- **Import:** `from filament import Filament`
+- **Python:** 3.10+
+- **Clients:** synchronous `Filament` and asynchronous `AsyncFilament`
+
+## Installation
+
+Until the first PyPI release, install from a Filament checkout:
+
+~~~sh
+uv add /path/to/filament/sdks/python
+~~~
+
+After the package is published:
+
+~~~sh
+uv add filament-py
+~~~
+
+For an existing virtual environment, use `uv pip install filament-py`.
+
+## Connect to Filament
+
+~~~python
+import os
+
+from filament import Filament
+
+filament = Filament(
+    base_url=os.getenv("FILAMENT_URL", "http://localhost:8080"),
+)
+
+for connector in filament.connector.list().connectors or []:
+    print(connector.name)
+~~~
+
+Set `FILAMENT_TOKEN` to a bearer token accepted by your server's identity provider.
+For a local server with authentication disabled, omit `token`. The SDK also accepts
+a callable token provider for credentials that need refreshing.
+
+You can configure request timeouts with `Filament(..., timeout=30)`; the value is
+in seconds. The SDK creates its HTTP client and supplies protocol headers.
+
+## Create and run a pipeline
+
+A **connector** is an available integration, such as `sample` or `stdout`.
+A **connection** is a configured instance you create using that connector.
+
+The workflow is:
+
+1. Create source and sink connections.
+2. Discover the source's resources and select which ones to include.
+3. Create a pipeline and save its graph.
+4. Submit a run.
+
+This complete example routes five rows from each selected sample resource to
+stdout. It requires a running Filament deployment with a working execution backend.
+
+~~~python
+import os
+from uuid import uuid4
+
+from filament import (
+    Filament,
+    IngestionV1PipelineEdge,
+    IngestionV1PipelineGraph,
+    IngestionV1PipelineNode,
+)
+
+filament = Filament(
+    base_url=os.getenv("FILAMENT_URL", "http://localhost:8080"),
+)
+name = f"sample-to-stdout-{uuid4().hex[:8]}"
+
+source = filament.connection.create(
+    name=f"{name}-source",
+    kind="CONNECTOR_KIND_SOURCE",
+    connector="sample",
+).connection
+
+sink = filament.connection.create(
+    name=f"{name}-sink",
+    kind="CONNECTOR_KIND_SINK",
+    connector="stdout",
+).connection
+
+resources = filament.connector.discover_resources(
+    connection_id=source.id,
+).resources or []
+
+# Select every available resource, or set this to ["users"].
+selected_resources = [
+    resource.name for resource in resources if resource.is_selectable
+]
+
+pipeline = filament.pipeline.create(name=name).pipeline
+
+filament.pipeline.version.create(
+    pipeline_id=pipeline.id,
+    graph=IngestionV1PipelineGraph(
+        nodes=[
+            IngestionV1PipelineNode(
+                id="source",
+                kind="CONNECTOR_KIND_SOURCE",
+                connection_id=source.id,
+                config={"rows": 5},
+            ),
+            IngestionV1PipelineNode(
+                id="sink",
+                kind="CONNECTOR_KIND_SINK",
+                connection_id=sink.id,
+            ),
+        ],
+        edges=[
+            IngestionV1PipelineEdge(
+                from_node="source",
+                to_node="sink",
+                resource=resource,
+            )
+            for resource in selected_resources
+        ],
+    ),
+)
+
+submitted = filament.pipeline.run(pipeline_id=pipeline.id)
+
+print("Pipeline:", pipeline.id)
+for edge_run in submitted.edge_runs or []:
+    print("Run:", edge_run.run.id, edge_run.run.status)
+~~~
+
+`pipeline.create(...)` creates the pipeline's metadata.
+`pipeline.version.create(...)` saves its graph; the backend assigns the version
+automatically. Both steps are required before the first run.
+
+The sample source discovers `users` and `orders`. To route all resources without
+enumerating them, save one edge with `resource` omitted. You still supply the source
+and sink nodes.
+
+Submitting a run returns its ID and initial status. It does not wait for completion.
+Inspect a run with `filament.run.get(run_id=run_id)`, or open the pipeline in the UI.
+The stdout sink writes rows to the worker's logs. The example leaves its connections,
+pipeline, and run available for inspection.
+
+The runnable version lives in
+[examples/smoke.py](https://github.com/galaxy-io/filament/blob/main/sdks/python/examples/smoke.py).
+From the repository root:
+
+~~~sh
+uv run --project sdks/python sdks/python/examples/smoke.py
+~~~
+
+## Async usage
+
+The async client exposes the same resource groups and methods.
+
+~~~python
+import asyncio
+import os
+
+from filament import AsyncFilament
+
+async def main():
+    filament = AsyncFilament(
+        base_url=os.getenv("FILAMENT_URL", "http://localhost:8080"),
+        token=os.getenv("FILAMENT_TOKEN"),
+    )
+    response = await filament.pipeline.list()
+    for pipeline in response.pipelines or []:
+        print(pipeline.id, pipeline.name)
+
+asyncio.run(main())
+~~~
+
+## API groups
+
+| Group | Examples |
+| --- | --- |
+| `connector` | `list`, `get`, `discover_resources`, `validate_config` |
+| `connection` | `create`, `get`, `list`, `update`, `delete` |
+| `pipeline` | `create`, `get`, `list`, `update`, `validate`, `run` |
+| `pipeline.version` | `create`, `get`, `list` |
+| `pipeline.schedule` | `create`, `update` |
+| `pipeline.notifier` | `create`, `list`, `update`, `delete` |
+| `run` | `get`, `list`, `signal` |
+| `metrics` | `query_timeseries`, `query_aggregate` |
+| `auth` | `get_config`, `get_session`, `login`, `logout` |
+| `member` | `list`, `invite`, `set_role`, `remove` |
+| `service_account` | `create`, `list`, `rotate_secret`, `remove` |
+
+The SDK covers unary API methods. Streaming `TailRun` is not included.
+
+## Responses and pagination
+
+Methods return generated models. For example, `pipeline.create(...)` returns a
+response whose `pipeline` property holds the created pipeline.
+
+Fields omitted by the server can be `None`, including lists. Use
+`response.pipelines or []` when iterating. Protobuf 64-bit integer fields, such as
+timestamps and record counts, can be decimal strings; use `int(value)` when needed.
+
+List methods expose explicit pagination:
+
+~~~python
+from filament import IngestionV1PaginationRequest
+
+page = filament.pipeline.list(
+    pagination=IngestionV1PaginationRequest(page_size=25),
+)
+next_cursor = page.pagination.next_cursor if page.pagination else None
+~~~
+
+Pass `next_cursor` as `IngestionV1PaginationRequest(cursor=next_cursor, page_size=25)`
+to fetch the next page when a cursor is present. Omitting pagination returns the
+full result set.
+
+## Errors and retries
+
+~~~python
+from filament.core.api_error import ApiError
+
+try:
+    filament.pipeline.get(id="missing-pipeline")
+except ApiError as error:
+    print(error.status_code)  # e.g. 404
+    print(error.body)         # Connect error code, message, and optional details
+~~~
+
+Automatic retries are disabled because mutations are not generally idempotent.
+For a read you want to retry, use
+`filament.pipeline.list(request_options={"max_retries": 2})`.
+
+## Development
+
+The client and models are generated by Fern from the protobuf-derived OpenAPI
+specification. Configure names and generation in `fern/`; do not edit
+`sdks/python/src/filament/` directly. This README and the package metadata are
+maintained separately and preserved across regeneration.
+
+From the repository root:
+
+~~~sh
+# Regenerate the OpenAPI specification and SDK (requires Buf and Fern login).
+just sdk-python
+
+# Install the SDK and run interoperability tests against an ephemeral Go server.
+uv sync --project sdks/python
+FILAMENT_SDK_PYTHON="$PWD/sdks/python/.venv/bin/python" GOWORK=off \
+  go test ./sdks/python/tests -run TestPythonSDK -count=1
+
+# Build the wheel and source distribution.
+uv build --no-sources --project sdks/python
+~~~
+
+See the [publishing guide](https://github.com/galaxy-io/filament/blob/main/sdks/python/PUBLISHING.md)
+for releasing `filament-py` to PyPI.
+
+## License
+
+Apache-2.0.