ibm-watsonx-ai-cli 0.1.1__tar.gz

ibm_watsonx_ai_cli-0.1.1/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 [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.

ibm_watsonx_ai_cli-0.1.1/PKG-INFO

@@ -0,0 +1,348 @@
+Metadata-Version: 2.3
+Name: ibm-watsonx-ai-cli
+Version: 0.1.1
+Summary: CLI for deploying AI services with Agents to watsonx.ai.
+Author: IBM
+Maintainer: Łukasz Ćmielowski
+Maintainer-email: lukasz.cmielowski@pl.ibm.com
+Requires-Python: >=3.10,<3.13
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: ibm-watsonx-ai (>=1.1.16,<2.0.0)
+Requires-Dist: tomli (>=2.0,<3.0.0)
+Requires-Dist: tomlkit (<1.0.0)
+Requires-Dist: typer (>=0.13.0,<1.0.0)
+Description-Content-Type: text/markdown
+
+# ibm-watsonx-ai-cli
+
+CLI tool that enables developers to deploy AI services to watsonx.ai directly from their local environment.
+
+# IBM watsonx.ai CLI for Agents
+
+Repository containing source code for `ibm-watsonx-ai-cli` package.
+
+## Contact info
+
+### Maintainers
+
+- **Łukasz Ćmielowski** - [lukasz.cmielowski@pl.ibm.com](mailto:lukasz.cmielowski@pl.ibm.com)
+- **Daniel Ryszka** – [daniel.ryszka@pl.ibm.com](mailto:daniel.ryszka@pl.ibm.com)
+- **Mateusz Szewczyk** – [mateusz.szewczyk@ibm.com](mailto:mateusz.szewczyk@ibm.com)
+- **Mateusz Świtała** – [mateusz.switala@ibm.com](mailto:mateusz.switala@ibm.com)
+## Installation
+
+```commandline
+pip install -U ibm-watsonx-ai-cli
+```
+
+## Usage
+
+### Run CLI
+
+```console
+$ watsonx-ai [OPTIONS] COMMAND [ARGS]...
+```
+
+[OPTIONS]
+```console
+--version  -v           Print the current CLI version.
+--help                  Show this message and exit.
+```
+
+COMMAND
+```console
+- template              Explore, download and try-out the template.
+- service               Work with deployed templates.
+```
+
+`TEMPLATE`
+```console
+- list                  List all available templates.
+- new                   Creates a selected template in a local env.  [ARGS: name, target]
+- invoke                Executes the template code locally with demo data.  [OPTIONAL ARGS: query]
+```
+
+`SERVICE`
+```console
+- list                   List all deployed AI services.
+- new                    Create & deploy a new ai service. [OPTIONAL ARGS: name]
+- get                    Get service details. [OPTIONAL ARGS: deployment_id (deployment_id)]
+- delete                 Deletes ai service. [ARGS: deployment_id]
+- invoke                 Calls the service by providing the test record. [OPTIONAL ARGS: deployment_id, query]
+```
+
+
+
+---
+
+### Template
+
+#### `watsonx-ai template list`
+
+List all available templates.
+
+__Usage:__
+
+```console
+$ watsonx-ai template list [OPTIONS]
+```
+
+__Options:__
+ - `--help`: Show this message and exit.
+
+#### `watsonx-ai template new`
+
+Creates a selected template in a local env.
+
+__Usage:__
+
+```console
+$ watsonx-ai template new [OPTIONS] name target
+```
+
+__Arguments:__
+
+ - `name`: Name of the template to download or its index in the list of available templates.
+ - `target`: Target directory where template will be saved.
+
+__Options:__
+ - `--help`: Show this message and exit.
+
+#### `watsonx-ai template invoke`
+
+Executes the template code locally with demo data.
+
+__Usage:__
+
+```console
+$ watsonx-ai template invoke [OPTIONS] query
+```
+
+__Arguments:__
+
+ - `query`:[Optional] Input query for template code. If not specified, searches for the `cli.options.payload_path` file to be specified in config.toml. Content of `cli.options.payload_path` will be directly send to the AI service and should agree with AI service request schema.
+
+__Options:__
+ - `--help`: Show this message and exit.
+
+### Service
+
+#### `watsonx-ai service list`
+
+List all deployed AI services.
+
+__Usage:__
+
+```console
+$ watsonx-ai service list [OPTIONS]
+```
+
+__Options:__
+ - `--help`: Show this message and exit.
+
+#### `watsonx-ai service new`
+
+Create & deploy a new AI service. After successful deployment creation the `deployment_id` will be saved automatically in section `[deployment]` in  `config.toml`.
+
+When running this command a package distribution with implemented agent will be created in folder `dist`. Warning! If `dist` already exists, distribution creation is skipped.
+
+__Usage:__
+
+```console
+$ watsonx-ai service new [OPTIONS] name
+```
+__Arguments:__
+
+ - `name`:[Optional] Name for the deployed AI service. If not provided, name for the deployment will be the same as name of current directory.
+
+__Options:__
+ - `--help`: Show this message and exit.
+
+
+#### `watsonx-ai service get`
+
+Get deployed service details.
+
+__Usage:__
+
+```console
+$ watsonx-ai service get [OPTIONS] deployment_id
+```
+__Arguments:__
+
+ - `deployment_id`: Id of the deployed AI service.
+
+__Options:__
+ - `--help`: Show this message and exit.
+
+
+#### `watsonx-ai service delete`
+
+Deletes ai service.
+
+__Usage:__
+
+```console
+$ watsonx-ai service delete [OPTIONS] deployment_id
+```
+__Arguments:__
+
+ - `deployment_id`: Id of the deployed AI service.
+
+__Options:__
+ - `--help`: Show this message and exit.
+
+
+#### `watsonx-ai service invoke`
+
+Calls the service by providing the test record.
+
+__Usage:__
+
+```console
+$ watsonx-ai service invoke [OPTIONS] query
+```
+__Arguments:__
+
+ - `query`:[Optional] Test data to send to deployed AI service. If not specified, searches for the `cli.options.payload_path` file to be specified in config.toml. Content of `cli.options.payload_path` will be directly send to the deployed AI service and should agree with AI service request schema.
+
+__Options:__
+
+- `--deployment_id`:[Optional] Id of a deployed AI service. If not provided, taken from `deployment.deployment_id` field from `config.toml`.
+ - `--help`: Show this message and exit.
+
+
+## Secrets
+
+### Environment Variables for IBM watsonx.ai for IBM Cloud
+For security reasons, it's recommended to not hard-code your API key or other secrets directly in your scripts or `config.toml`. Instead, set it up as an environment variable. Below variables will be used to authenticate to watsonx.ai APIs if analogous ones not provided in configuration file.
+
+```python
+import os
+
+WATSONX_URL = os.environ.get("WATSONX_URL", "")
+WATSONX_APIKEY = os.environ.get("WATSONX_APIKEY", "")
+WATSONX_TOKEN = os.environ.get("WATSONX_TOKEN", "")
+WATSONX_SPACE_ID = os.environ.get("WATSONX_SPACE_ID", "")
+WATSONX_PROJECT_ID = os.environ.get("WATSONX_PROJECT_ID", "")
+```
+### Environment Variables for IBM watsonx.ai Software
+In the IBM watsonx.ai Software, the environment variable configuration is extended. In addition to supporting the variables listed above for the Cloud Environment, the following environment variables are also supported:
+
+```python
+import os
+
+WATSONX_PASSWORD = os.environ.get("WATSONX_PASSWORD", "")
+WATSONX_USERNAME = os.environ.get("WATSONX_USERNAME", "")
+WATSONX_INSTANCE_ID = os.environ.get("WATSONX_INSTANCE_ID", "")
+```
+
+**Note:** All environment variables supported in the Cloud Environment are also available in the IBM watsonx.ai Software.
+
+### Config file (`config.toml`)
+`config.toml` is an optional file that can be defined in template's directory. Please note, that some templates will require a correctly prepared `config.toml` since template's content may depends on some of the available configuration options. If a downloaded template has `config.toml` with placeholders, please read its description carefully and fill in required fields.
+
+#### Available configuration options
+
+Below are all the sections and options you can have in your `config.toml`
+
+[cli.options]
+```yaml
+[cli.options]
+  # If true, cli `invoke` command is trying to use `ai_service.generate_stream` function for local tests, and `ai_service.generate` otherwise.
+  # Default: true
+  stream = true
+
+  # Path to json file with a complete payload that will be send to proper AI service generate function.
+  # Note that, the payload file will be only used when no `query` is provided when running `invoke ` command
+  # Default: None
+  payload_path = ""
+
+```
+
+
+[deployment]
+
+If present, its fields will be used for authentication to watsonx.ai APIs.
+```yaml
+[deployment]
+  # One of the below is required.
+  # To determine your `api_key`, refer to `IBM Cloud console API keys <https://cloud.ibm.com/iam/apikeys>`_.
+  watsonx_apikey = "PLACEHOLDER FOR YOUR APIKEY"
+  watsonx_token = "PLACEHOLDER FOR YOUR TOKEN"
+
+  # should follow the format: `https://{REGION}.ml.cloud.ibm.com`
+  watsonx_url = ""
+
+  # Deployment space id is required to create deployment with AI service content.
+  space_id = "PLACEHOLDER FOR YOUR SPACE ID"
+
+  # variable, that is populated with last created deployment_id every time when command `watsonx-ai service new` finish successfully
+  deployment_id = ""
+
+  # The following parameters, along with the ones defined above, are supported by IBM watsonx.ai Software.
+  watsonx_password = ""
+  watsonx_username = ""
+  watsonx_instance_id = ""
+```
+
+[deployment.online.parameters]
+
+This section is recommended for users of IBM watsonx.ai for IBM Cloud and when some additional parameters need to be passed to the AI service function during deployment creation. When creating a deployment, additional parameters can be passed inside the `ONLINE.PARAMETERS` object to further reference in the content of the AI service function. The exact set of parameters may depend on the template used.
+```yaml
+[deployment.online.parameters]
+
+# Example set of parameters that must be passed during deployment creation of particular template to guarantee its correct functioning
+  url = ""  # should follow the format: `https://{REGION}.ml.cloud.ibm.com`
+  space_id = "PLACEHOLDER FOR YOUR SPACE ID"
+  model_id = "mistralai/mistral-large"  # underlying model for inference
+```
+
+[deployment.software_specification]
+
+During deployment creation, the custom software specification with template package distribution is stored for use when running AI service inference. For more details about software specifications you can find in _IBM watsonx.ai Runtime Supported frameworks and software specifications_ [documentation](https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/pm_service_supported_frameworks.html?context=wx&audience=wdp) and _Customizing deployment runtimes_ [documentation](https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/ml-customize.html?context=wx&audience=wdp).
+```yaml
+[deployment.software_specification]
+  # Name for derived software specification. If not provided, default one is used that will be build based on the package name: "{pkg_name}-sw-spec"
+  name = ""
+
+  # Whether to overwrite (delete existing and create new with the same name) watsonx derived software specification
+  # Default: false
+  overwrite = false
+
+  # The base software specification used to deploy the AI service. The template dependencies will be installed based on the packages included in the selected base software specification
+  # Default: "runtime-24.1-py3.11"
+  base_sw_spec = "runtime-24.1-py3.11"
+```
+
+## Sample flow
+1. List available templates
+   ```console
+   watsonx-ai template list
+   ```
+2. Create the template in my IDE
+
+   ```console
+   watsonx-ai template new "base/langgraph-react-agent" "apps"
+   ```
+3. Go into template directory
+   ```console
+   cd apps/langgraph-react-agent
+   ```
+4. Customize the template code and `config.toml` to my needs
+5. Test the template code by calling invoke:
+   ```console
+   watsonx-ai template invoke "question"
+   ```
+6. Create a service
+   ```console
+   watsonx-ai service new
+   ```
+7. Test the service
+   ```console
+   watsonx-ai service invoke "question"
+   ```
+