flowstash-cli 0.2.0__tar.gz → 0.2.3__tar.gz

{flowstash_cli-0.2.0 → flowstash_cli-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: flowstash-cli
-Version: 0.2.0
+Version: 0.2.3
 Summary: CLI for the flowstash Managed Platform
 Author: juraj.bezdek@gmail.com
 Author-email: juraj.bezdek@gmail.com
@@ -9,7 +9,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: flowstash-runtime (>=0.1.2,<0.2.0)
+Requires-Dist: flowstash-runtime (>=0.2.3,<0.3.0)
 Requires-Dist: httpx (>=0.27.0)
 Requires-Dist: keyring (>=25.0.0)
 Requires-Dist: libcst (>=1.1.0)

{flowstash_cli-0.2.0 → flowstash_cli-0.2.3}/pyproject.toml

@@ -1,11 +1,11 @@
 [project]
 name = "flowstash-cli"
-version = "0.2.0"
+version = "0.2.3"
 description = "CLI for the flowstash Managed Platform"
 authors = [{name = "juraj.bezdek@gmail.com", email = "juraj.bezdek@gmail.com"}]
 requires-python = ">=3.11"
 dependencies = [
-    "flowstash-runtime>=0.1.2,<0.2.0",
+    "flowstash-runtime>=0.2.3,<0.3.0",
     "typer[all]>=0.12.0",
     "httpx>=0.27.0",
     "pyyaml>=6.0.1",

{flowstash_cli-0.2.0 → flowstash_cli-0.2.3}/src/flowstash/cli/templates/AGENTS.md

@@ -114,13 +114,52 @@ with integration_context(integration="my-int", integration_pipeline="pipe"):
 flowstash makes it easy to interact with external APIs via Clients. They handle setting Base URLs, automatic Authentication headers, observability tracing, and defaults out of the box.
 
 ### Adding a Client
-To configure a new REST client, you place a configuration file (like `slackClient.yaml`) in your shared clients folder. flowstash dynamically loads these clients if your configuration registry points to the folder. For example, if you have `_config/shared/clients.yaml` configured as follows:
+
+To configure a new REST client, you place a configuration file (like `slackClient.yaml`) in your shared clients folder. flowstash dynamically loads these clients if your configuration registry points to the folder.
+
+#### The `clients.yaml` Pointer
+The `clients.yaml` file in your shared configuration folder tells flowstash where to find your client definitions. Its schema is defined by `ClientsConfigPointer` in `flowstash.config.runtime_config`:
+
+```yaml
+path: clients       # Relative or absolute path to the clients directory
+pattern: "*.yaml"   # Glob pattern to match client files (default: "*.yaml")
+recursive: false    # If true, searches subdirectories (default: false)
+```
+
+#### Client Settings Schema
+Each individual client file follows the `ClientSettings` schema defined in `flowstash.clients.config`. You can use either camelCase (default) or snake_case for field names.
+
+Common fields:
+- `baseUrl` (or `base_url`): The root URL for all requests.
+- `timeout`: Request timeout in seconds (default: 10.0).
+- `auth`: Authentication configuration.
+- `retry`: Configuration for automatic retries.
+
+#### Example: API Key Authentication
 ```yaml
-path: clients
-pattern: "*.yaml"
+client_id: myClient            # Optional: defaults to filename
+baseUrl: https://api.example.com
+auth:
+  type: api_key
+  key: "X-API-Key"             # Header or query parameter name
+  value: "${MY_API_KEY}"       # Value (supports environment variables)
+  in: header                   # Place in "header" (default) or "query"
 ```
+
+#### Example: OAuth2 Authentication
+```yaml
+baseUrl: https://api.service.com
+auth:
+  type: oauth2
+  client_id: "${CLIENT_ID}"
+  client_secret: "${CLIENT_SECRET}"
+  token_url: "https://auth.service.com/oauth/token"
+  scopes: ["read", "write"]
+```
+
 You can simply define `clients/slackClient.yaml` and the system will expose it to your tasks.
 
+
 ### Using a Client
 Once configured, you can retrieve the standard HTTP client (from the `flowstash.clients` package) anywhere.
 
@@ -145,7 +184,7 @@ from flowstash.clients import HttpClient, client
 from typing import List
 
 # Extending HttpClient and registering with the @client decorator
-@client("DemoClient")
+@client("demoClient") # Make sure the clientId ('demoClient') matches the clientId in yaml / config file name (if not specified in config yaml)
 class DemoClient(HttpClient):
     """Custom client for the Demo API."""
     
@@ -157,6 +196,11 @@ class DemoClient(HttpClient):
         response = await self.request("GET", f"/users/{user_id}")
         return response.json()
 
+    @classmethod
+    def get(cls) -> DemoClient:
+        return get_client("demoClient") 
+
+
 # You can then resolve this custom client by name:
 # demo = get_client("DemoClient")
 ```