Metadata-Version: 2.1
Name: ibm-ai-openscale-cli
Version: 0.1.14
Summary: CLI library to automate the onboarding process to IBM AI OpenScale
Home-page: https://www.ibm.com/cloud/ai-openscale
Author: IBM Corp
Author-email: wps@us.ibm.com
License: Apache-2.0
Keywords: ai-openscale,ibm-watson
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Requires-Dist: requests (<3.0,>=2.0)
Requires-Dist: ibm-ai-openscale (<2.0,>=1.0.188)
Requires-Dist: watson-machine-learning-client (<2.0,>=1.0.339)
Requires-Dist: ibm-db (==2.0.9)
Requires-Dist: urllib3 (==1.23)
Requires-Dist: retry (>=0.9.0)
Requires-Dist: outdated (>=0.1.1)

ibm-ai-openscale-cli
====================

|Status| |Latest Stable Version|

This tool allows user to get started real quick by exploring the
environment to understand what user has, and then provision
corresponding services needed to run AI OpenScale, then setup the models
and setup monitoring conditions.

Before you begin
----------------

-  ☁️ You need an `IBM Cloud <https://cloud.ibm.com>`__ account.
-  🔑 Create an `IBM Cloud API
   key <https://console.bluemix.net/docs/iam/userid_keys.html#userapikey>`__
-  ⚠️ If you already have a Watson Machine Learning (WML) instance,
   ensure it's RC-enabled, learn more about this in the `migration
   instructions <https://console.bluemix.net/docs/resources/instance_migration.html#migrate>`__.

Installation
------------

To install, use ``pip`` or ``easy_install``:

.. code:: bash

    pip install -U ibm-ai-openscale-cli

or

.. code:: bash

    easy_install -U ibm-ai-openscale-cli

️️ ## Usage

::

    ibm-ai-openscale-cli --help

::

    usage: ibm-ai-openscale-cli [-h] -a APIKEY [--env {ypprod,icp}]
              [--resource-group RESOURCE_GROUP] [--organization ORGANIZATION]
              [--space SPACE] [--postgres POSTGRES] [--db2 DB2] [--wml WML]
              [--username USERNAME] [--password PASSWORD] [--url URL]
              [--datamart-name DATAMART_NAME] [--history HISTORY] [--bx]
              [--verbose] [--version]

    optional arguments:
      -h, --help            show this help message and exit
      --env {ypprod,icp}    Environment. Default "ypprod"
      --resource-group RESOURCE_GROUP
                            Resource Group to use. If not specified, then
                            "default" group is used
      --organization ORGANIZATION
                            Cloud Foundry Organization to use
      --space SPACE         Cloud Foundry Space to use
      --postgres POSTGRES   Path to postgres credentials file. If not specified,
                            then the internal AIOS database is used
      --db2 DB2             Path to db2 credentials file
      --wml WML             Path to WML credentials file
      --username USERNAME   ICP username. Required if "icp" environment is chosen
      --password PASSWORD   ICP password. Required if "icp" environment is chosen
      --url URL             ICP url. Required if "icp" environment is chosen
      --datamart-name DATAMART_NAME
                            Specify data mart name, default is "aiosfastpath"
      --history HISTORY     Days of history to preload. Default is 7
      --bx                  Specify (without a value) to use IBM Cloud CLI (bx
                            CLI), default uses Rest API
      --verbose             verbose flag
      --version             show program's version number and exit

    required arguments:
      -a APIKEY, --apikey APIKEY
                            IBM Cloud APIKey

Example
-------

.. code:: sh

    export APIKEY=<PLATFORM_API_KEY>
    ibm-ai-openscale-cli --apikey $APIKEY

Python version
--------------

✅ Tested on Python 3.4, 3.5, and 3.6.

Contributing
------------

See `CONTRIBUTING.md <./CONTRIBUTING.md>`__.

License
-------

This library is licensed under the `Apache 2.0
license <http://www.apache.org/licenses/LICENSE-2.0>`__.

.. |Status| image:: https://img.shields.io/badge/status-beta-yellow.svg
.. |Latest Stable Version| image:: https://img.shields.io/pypi/v/ibm-ai-openscale-cli.svg
   :target: https://pypi.python.org/pypi/ibm-ai-openscale-cli


