pipedream 0.3.0__tar.gz → 0.3.1__tar.gz

pipedream-0.3.1/LICENSE

@@ -0,0 +1,123 @@
+Pipedream Source Available License Version 1.0
+
+This Pipedream Source Available License Agreement Version 1.0 (this
+“Agreement”) sets forth the terms on which Pipedream, Inc., a Delaware
+corporation (“Pipedream”) makes available certain software (the
+“Software”). By installing, downloading, accessing, using or
+distributing the Software, you agree to the terms of this
+Agreement. If you do not agree to such terms, you must not use the
+Software. If you are receiving the Software on behalf of a legal
+entity, you represent and warrant that you have the actual authority
+to agree to the terms and conditions of this Agreement on behalf of
+such entity. “Licensee” means you, an individual, or the entity on
+whose behalf you are receiving the Software.
+
+LICENSE GRANT AND CONDITIONS.
+
+1.1 License. Subject to the terms and conditions of this Agreement,
+Pipedream hereby grants to Licensee a non-exclusive, royalty-free,
+worldwide, non-transferable, non-sublicenseable license during the
+term of this Agreement to use, prepare modifications and derivative
+works, distribute (including without limitation in source code or
+object code form) and reproduce copies of the Software (the
+“License”). Licensee is not granted the right to, and Licensee shall
+not, exercise the License for an Excluded Purpose. For purposes of
+this Agreement, “Excluded Purpose” means any commercial use of the
+software including, but not limited to, making available any
+software-as-a-service, platform-as-a-service,
+infrastructure-as-a-service or other online service that competes with
+the Software or any other Pipedream products or services.
+
+1.2 Conditions. In consideration of the License, Licensee’s
+distribution of the Software is subject to the following conditions:
+
+a. Licensee must cause any Software modified by Licensee to carry
+prominent notices stating that Licensee modified the Software.
+
+b. On each Software copy, Licensee shall reproduce and not remove or
+alter all Pipedream or third party copyright or other proprietary
+notices contained in the Software, and Licensee must provide this with
+each copy: “This software is made available by Pipedream, Inc., under
+the terms of the Pipedream Source Available License, Version 1.0
+located at
+https://github.com/PipedreamHQ/pipedream/blob/master/LICENSE. By
+installing, downloading, accessing, using or distributing the
+Software, you agree to the terms of such License Agreement.”
+
+1.3 Modifications. Licensee may add its own copyright notices to
+modifications made by Licensee and may provide additional or different
+license terms and conditions for use, reproduction, or distribution of
+Licensee’s modifications. While redistributing the Software or
+modifications thereof, Licensee may choose to offer, for a fee or free
+of charge, support, warranty, indemnity, or other
+obligations. Licensee, and not Pipedream, will be responsible for any
+such obligations.
+
+1.4 No Sublicensing. The License does not include the right to
+sublicense the Software; provided, however, that any recipient to
+which Licensee provides the Software may exercise the License so long
+as such recipient agrees to the terms and conditions of this
+Agreement.
+
+TERM AND TERMINATION.
+
+This Agreement will continue unless and until earlier terminated as
+set forth herein. If Licensee breaches any of its conditions or
+obligations under this Agreement, this Agreement will terminate
+automatically and the License will terminate automatically and
+permanently.
+
+INTELLECTUAL PROPERTY.
+
+As between the parties, Pipedream retains all right, title, and
+interest in the Software, and all intellectual property rights
+therein. Pipedream hereby reserves all rights not expressly granted to
+Licensee in this Agreement. Pipedream reserves all rights in its
+trademarks and service marks, and no licenses thereto are granted by
+this Agreement.
+
+DISCLAIMER.
+
+PIPEDREAM HEREBY DISCLAIMS ANY AND ALL WARRANTIES AND CONDITIONS,
+EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, AND SPECIFICALLY DISCLAIMS
+ANY WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE,
+WITH RESPECT TO THE SOFTWARE.
+
+LIMITATION OF LIABILITY.
+
+PIPEDREAM WILL NOT BE LIABLE FOR ANY DAMAGES OF ANY KIND, INCLUDING
+BUT NOT LIMITED TO, LOST PROFITS OR ANY CONSEQUENTIAL, SPECIAL,
+INCIDENTAL, INDIRECT, OR DIRECT DAMAGES, HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, ARISING OUT OF THIS AGREEMENT. THE FOREGOING
+SHALL APPLY TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW.
+
+GENERAL.
+
+6.1 Governing Law. This Agreement will be governed by and interpreted
+in accordance with the laws of the state of California, without
+reference to its conflict of laws principles. If Licensee is located
+outside of the United States, any dispute, controversy or claim
+arising out of or relating to this Agreement will be referred to and
+finally determined by arbitration in accordance with the JAMS
+International Arbitration Rules. The tribunal will consist of one
+arbitrator. Judgment upon the award rendered by the arbitrator may be
+entered in any court having jurisdiction thereof. All disputes
+including arbitrations shall take place in Santa Clara County,
+California. The language to be used in any such proceedings shall be
+English.
+
+6.2.  Assignment. Licensee is not authorized to assign its rights
+under this Agreement to any third party. Pipedream may freely assign
+its rights under this Agreement to any third party.
+
+6.3.  Other. This Agreement is the entire agreement between the
+parties regarding the subject matter hereof. No amendment or
+modification of this Agreement will be valid or binding upon the
+parties unless made in writing and signed by the duly authorized
+representatives of both parties. In the event that any provision,
+including without limitation any condition, of this Agreement is held
+to be unenforceable, this Agreement and all licenses and rights
+granted hereunder will immediately terminate. Waiver by Pipedream of a
+breach of any provision of this Agreement or the failure by Pipedream
+to exercise any right hereunder will not be construed as a waiver of
+any subsequent breach of that right or as a waiver of any other right.

pipedream-0.3.1/PKG-INFO

@@ -0,0 +1,221 @@
+Metadata-Version: 2.1
+Name: pipedream
+Version: 0.3.1
+Summary: 
+Requires-Python: >=3.8,<4.0
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: OS Independent
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Dist: httpx (>=0.21.2)
+Requires-Dist: pydantic (>=1.9.2)
+Requires-Dist: pydantic-core (>=2.18.2)
+Requires-Dist: typing_extensions (>=4.0.0)
+Description-Content-Type: text/markdown
+
+# Pipedream Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2FPipedreamHQ%2Fpipedream-sdk-python)
+[![pypi](https://img.shields.io/pypi/v/pipedream)](https://pypi.python.org/pypi/pipedream)
+
+The Pipedream Python library provides convenient access to the Pipedream API from Python.
+
+## Installation
+
+```sh
+pip install pipedream
+```
+
+## Reference
+
+A full reference for this library is available [here](https://github.com/PipedreamHQ/pipedream-sdk-python/blob/HEAD/./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from pipedream import Pipedream
+
+client = Pipedream(
+    project_id="YOUR_PROJECT_ID",
+    x_pd_environment="YOUR_X_PD_ENVIRONMENT",
+    client_id="YOUR_CLIENT_ID",
+    client_secret="YOUR_CLIENT_SECRET",
+)
+client.accounts.create(
+    app_slug="app_slug",
+    cfmap_json="cfmap_json",
+    connect_token="connect_token",
+)
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API.
+
+```python
+import asyncio
+
+from pipedream import AsyncPipedream
+
+client = AsyncPipedream(
+    project_id="YOUR_PROJECT_ID",
+    x_pd_environment="YOUR_X_PD_ENVIRONMENT",
+    client_id="YOUR_CLIENT_ID",
+    client_secret="YOUR_CLIENT_SECRET",
+)
+
+
+async def main() -> None:
+    await client.accounts.create(
+        app_slug="app_slug",
+        cfmap_json="cfmap_json",
+        connect_token="connect_token",
+    )
+
+
+asyncio.run(main())
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```python
+from pipedream.core.api_error import ApiError
+
+try:
+    client.accounts.create(...)
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## Pagination
+
+Paginated requests will return a `SyncPager` or `AsyncPager`, which can be used as generators for the underlying object.
+
+```python
+from pipedream import Pipedream
+
+client = Pipedream(
+    project_id="YOUR_PROJECT_ID",
+    x_pd_environment="YOUR_X_PD_ENVIRONMENT",
+    client_id="YOUR_CLIENT_ID",
+    client_secret="YOUR_CLIENT_SECRET",
+)
+response = client.apps.list()
+for item in response:
+    yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+    yield page
+```
+
+## Advanced
+
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.with_raw_response` property.
+The `.with_raw_response` property returns a "raw" client that can be used to access the `.headers` and `.data` attributes.
+
+```python
+from pipedream import Pipedream
+
+client = Pipedream(
+    ...,
+)
+response = client.accounts.with_raw_response.create(...)
+print(response.headers)  # access the response headers
+print(response.data)  # access the underlying object
+pager = client.apps.list(...)
+print(pager.response.headers)  # access the response headers for the first page
+for item in pager:
+    print(item)  # access the underlying object(s)
+for page in pager.iter_pages():
+    print(page.response.headers)  # access the response headers for each page
+    for item in page:
+        print(item)  # access the underlying object(s)
+```
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retryable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `max_retries` request option to configure this behavior.
+
+```python
+client.accounts.create(..., request_options={
+    "max_retries": 1
+})
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
+
+```python
+
+from pipedream import Pipedream
+
+client = Pipedream(
+    ...,
+    timeout=20.0,
+)
+
+
+# Override timeout for a specific method
+client.accounts.create(..., request_options={
+    "timeout_in_seconds": 1
+})
+```
+
+### Custom Client
+
+You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
+and transports.
+
+```python
+import httpx
+from pipedream import Pipedream
+
+client = Pipedream(
+    ...,
+    httpx_client=httpx.Client(
+        proxies="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!
+

pipedream-0.3.1/README.md

@@ -0,0 +1,194 @@
+# Pipedream Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2FPipedreamHQ%2Fpipedream-sdk-python)
+[![pypi](https://img.shields.io/pypi/v/pipedream)](https://pypi.python.org/pypi/pipedream)
+
+The Pipedream Python library provides convenient access to the Pipedream API from Python.
+
+## Installation
+
+```sh
+pip install pipedream
+```
+
+## Reference
+
+A full reference for this library is available [here](https://github.com/PipedreamHQ/pipedream-sdk-python/blob/HEAD/./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from pipedream import Pipedream
+
+client = Pipedream(
+    project_id="YOUR_PROJECT_ID",
+    x_pd_environment="YOUR_X_PD_ENVIRONMENT",
+    client_id="YOUR_CLIENT_ID",
+    client_secret="YOUR_CLIENT_SECRET",
+)
+client.accounts.create(
+    app_slug="app_slug",
+    cfmap_json="cfmap_json",
+    connect_token="connect_token",
+)
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API.
+
+```python
+import asyncio
+
+from pipedream import AsyncPipedream
+
+client = AsyncPipedream(
+    project_id="YOUR_PROJECT_ID",
+    x_pd_environment="YOUR_X_PD_ENVIRONMENT",
+    client_id="YOUR_CLIENT_ID",
+    client_secret="YOUR_CLIENT_SECRET",
+)
+
+
+async def main() -> None:
+    await client.accounts.create(
+        app_slug="app_slug",
+        cfmap_json="cfmap_json",
+        connect_token="connect_token",
+    )
+
+
+asyncio.run(main())
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```python
+from pipedream.core.api_error import ApiError
+
+try:
+    client.accounts.create(...)
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## Pagination
+
+Paginated requests will return a `SyncPager` or `AsyncPager`, which can be used as generators for the underlying object.
+
+```python
+from pipedream import Pipedream
+
+client = Pipedream(
+    project_id="YOUR_PROJECT_ID",
+    x_pd_environment="YOUR_X_PD_ENVIRONMENT",
+    client_id="YOUR_CLIENT_ID",
+    client_secret="YOUR_CLIENT_SECRET",
+)
+response = client.apps.list()
+for item in response:
+    yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+    yield page
+```
+
+## Advanced
+
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.with_raw_response` property.
+The `.with_raw_response` property returns a "raw" client that can be used to access the `.headers` and `.data` attributes.
+
+```python
+from pipedream import Pipedream
+
+client = Pipedream(
+    ...,
+)
+response = client.accounts.with_raw_response.create(...)
+print(response.headers)  # access the response headers
+print(response.data)  # access the underlying object
+pager = client.apps.list(...)
+print(pager.response.headers)  # access the response headers for the first page
+for item in pager:
+    print(item)  # access the underlying object(s)
+for page in pager.iter_pages():
+    print(page.response.headers)  # access the response headers for each page
+    for item in page:
+        print(item)  # access the underlying object(s)
+```
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retryable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `max_retries` request option to configure this behavior.
+
+```python
+client.accounts.create(..., request_options={
+    "max_retries": 1
+})
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
+
+```python
+
+from pipedream import Pipedream
+
+client = Pipedream(
+    ...,
+    timeout=20.0,
+)
+
+
+# Override timeout for a specific method
+client.accounts.create(..., request_options={
+    "timeout_in_seconds": 1
+})
+```
+
+### Custom Client
+
+You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
+and transports.
+
+```python
+import httpx
+from pipedream import Pipedream
+
+client = Pipedream(
+    ...,
+    httpx_client=httpx.Client(
+        proxies="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!

pipedream-0.3.1/pyproject.toml

@@ -0,0 +1,84 @@
+[project]
+name = "pipedream"
+
+[tool.poetry]
+name = "pipedream"
+version = "0.3.1"
+description = ""
+readme = "README.md"
+authors = []
+keywords = []
+
+classifiers = [
+    "Intended Audience :: Developers",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Operating System :: OS Independent",
+    "Operating System :: POSIX",
+    "Operating System :: MacOS",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: Microsoft :: Windows",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed"
+]
+packages = [
+    { include = "pipedream", from = "src"}
+]
+
+[project.urls]
+Repository = 'https://github.com/PipedreamHQ/pipedream-sdk-python'
+
+[tool.poetry.dependencies]
+python = "^3.8"
+httpx = ">=0.21.2"
+pydantic = ">= 1.9.2"
+pydantic-core = ">=2.18.2"
+typing_extensions = ">= 4.0.0"
+
+[tool.poetry.group.dev.dependencies]
+mypy = "==1.13.0"
+pytest = "^7.4.0"
+pytest-asyncio = "^0.23.5"
+python-dateutil = "^2.9.0"
+types-python-dateutil = "^2.9.0.20240316"
+ruff = "==0.11.5"
+
+[tool.pytest.ini_options]
+testpaths = [ "tests" ]
+asyncio_mode = "auto"
+
+[tool.mypy]
+plugins = ["pydantic.mypy"]
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+select = [
+    "E",  # pycodestyle errors
+    "F",  # pyflakes
+    "I",  # isort
+]
+ignore = [
+    "E402",  # Module level import not at top of file
+    "E501",  # Line too long
+    "E711",  # Comparison to `None` should be `cond is not None`
+    "E712",  # Avoid equality comparisons to `True`; use `if ...:` checks
+    "E721",  # Use `is` and `is not` for type comparisons, or `isinstance()` for insinstance checks
+    "E722",  # Do not use bare `except`
+    "E731",  # Do not assign a `lambda` expression, use a `def`
+    "F821",  # Undefined name
+    "F841"   # Local variable ... is assigned to but never used
+]
+
+[tool.ruff.lint.isort]
+section-order = ["future", "standard-library", "third-party", "first-party"]
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"