clarifai 11.6.4rc2__py3-none-any.whl → 11.6.6__py3-none-any.whl

clarifai/__init__.py

@@ -1 +1 @@
-__version__ = "11.6.4rc2"
+__version__ = "11.6.6"

clarifai/cli/README.md

@@ -8,6 +8,45 @@ Clarifai offers a user-friendly interface for deploying your local model into pr
 * Easy implementation and testing in Python
 * No need for MLops expertise.
 
+## Context Management
+
+Manage CLI contexts for authentication and environment configuration:
+### List all contexts
+```bash
+clarifai config get-contexts
+```
+
+### Switch context
+```bash
+clarifai config use-context production
+```
+### Show current context
+```bash
+clarifai config current-context
+```
+
+### Create new context
+```bash
+clarifai config create-context staging --user-id myuser --pat 678***
+```
+### View entire configuration
+```bash
+clarifai config view
+```
+### Delete a context
+```bash
+clarifai config delete-context old-context
+```
+### Edit configuration file
+```bash
+clarifai config edit
+```
+
+### Print environment variables for the active context
+```bash
+clarifai context env
+```
+
 ## Compute Orchestration
 
 Quick example for deploying a `visual-classifier` model

clarifai/cli/base.py

@@ -1,6 +1,6 @@
+import getpass
 import json
 import os
-import shutil
 import sys
 
 import click
@@ -13,7 +13,6 @@ from clarifai.utils.constants import DEFAULT_BASE, DEFAULT_CONFIG, DEFAULT_UI
 from clarifai.utils.logging import logger
 
 
-# @click.group(cls=CustomMultiGroup)
 @click.group(cls=AliasedGroup)
 @click.version_option(version=__version__)
 @click.option('--config', default=DEFAULT_CONFIG)
@@ -54,42 +53,82 @@ def shell_completion(shell):
     os.system(f"_CLARIFAI_COMPLETE={shell}_source clarifai")
 
 
-@cli.group(
-    ['cfg'],
-    cls=AliasedGroup,
-    context_settings={'max_content_width': shutil.get_terminal_size().columns - 10},
-)
+@cli.group(cls=AliasedGroup)
 def config():
-    """Manage CLI configuration"""
+    """
+    Manage multiple configuration profiles (contexts).
 
+    Authentication Precedence:\n
+      1. Environment variables (e.g., `CLARIFAI_PAT`) are used first if set.
+      2. The settings from the active context are used if no environment variables are provided.\n
+    """
 
-@config.command(['e'])
+
+@cli.command()
+@click.argument('api_url', default=DEFAULT_BASE)
+@click.option('--user_id', required=False, help='User ID')
 @click.pass_context
-def edit(ctx):
-    """Edit the configuration file"""
-    os.system(f'{os.environ.get("EDITOR", "vi")} {ctx.obj.filename}')
+def login(ctx, api_url, user_id):
+    """Login command to set PAT and other configurations."""
+    from clarifai.utils.cli import validate_context_auth
 
+    click.echo('> To authenticate, you\'ll need a Personal Access Token (PAT).')
+    click.echo(
+        '> You can create one from your account settings: https://clarifai.com/settings/security\n'
+    )
 
-@config.command(['current'])
-@click.option('-o', '--output-format', default='name', type=click.Choice(['name', 'json', 'yaml']))
-@click.pass_context
-def current_context(ctx, output_format):
-    """Get the current context"""
-    if output_format == 'name':
-        print(ctx.obj.current_context)
-    elif output_format == 'json':
-        print(json.dumps(ctx.obj.contexts[ctx.obj.current_context].to_serializable_dict()))
-    else:
-        print(yaml.safe_dump(ctx.obj.contexts[ctx.obj.current_context].to_serializable_dict()))
+    # Securely input PAT
+    pat = getpass.getpass('Enter your Personal Access Token: ')
+
+    # Input user_id if not supplied
+    if not user_id:
+        user_id = click.prompt('Enter your Clarifai user ID', type=str)
+
+    # Progress indicator
+    click.echo('\n> Verifying token...')
+    validate_context_auth(pat, user_id, api_url)
+
+    # Context naming
+    default_context_name = 'default'
+    click.echo('\n> Let\'s save these credentials to a new context.')
+    click.echo('> You can have multiple contexts to easily switch between accounts or projects.\n')
+    context_name = click.prompt("Enter a name for this context", default=default_context_name)
+
+    # Save context
+    context = Context(
+        context_name,
+        CLARIFAI_API_BASE=api_url,
+        CLARIFAI_USER_ID=user_id,
+        CLARIFAI_PAT=pat,
+    )
+
+    ctx.obj.contexts[context_name] = context
+    ctx.obj.current_context = context_name
+    ctx.obj.to_yaml()
+    click.secho('✅ Success! You are now logged in.', fg='green')
+    click.echo(f'Credentials saved to the \'{context_name}\' context.\n')
+    click.echo('💡 To switch contexts later, use `clarifai config use-context <name>`.')
+
+    logger.info(f"Login successful for user '{user_id}' in context '{context_name}'")
+
+
+def pat_display(pat):
+    return pat[:5] + "****"
+
+
+def input_or_default(prompt, default):
+    value = input(prompt)
+    return value if value else default
 
 
-@config.command(['list', 'ls'])
+# Context management commands under config group
+@config.command(aliases=['get-contexts', 'list-contexts'])
 @click.option(
     '-o', '--output-format', default='wide', type=click.Choice(['wide', 'name', 'json', 'yaml'])
 )
 @click.pass_context
 def get_contexts(ctx, output_format):
-    """Get all contexts"""
+    """List all available contexts."""
     if output_format == 'wide':
         columns = {
             '': lambda c: '*' if c.name == ctx.obj.current_context else '',
@@ -106,7 +145,6 @@ def get_contexts(ctx, output_format):
                         additional_columns.add(key)
         for key in sorted(additional_columns):
             columns[key] = lambda c, k=key: getattr(c, k) if hasattr(c, k) else ""
-
         formatter = TableFormatter(
             custom_columns=columns,
         )
@@ -123,101 +161,45 @@ def get_contexts(ctx, output_format):
             print(yaml.safe_dump(dicts))
 
 
-@config.command(['use'])
-@click.argument('context-name', type=str)
+@config.command(aliases=['use-context'])
+@click.argument('name', type=str)
 @click.pass_context
-def use_context(ctx, context_name):
-    """Set the current context"""
-    if context_name not in ctx.obj.contexts:
+def use_context(ctx, name):
+    """Set the current context."""
+    if name not in ctx.obj.contexts:
         raise click.UsageError('Context not found')
-    ctx.obj.current_context = context_name
+    ctx.obj.current_context = name
     ctx.obj.to_yaml()
-    print(f'Set {context_name} as the current context')
-
-
-@config.command(['cat'])
-@click.option('-o', '--output-format', default='yaml', type=click.Choice(['yaml', 'json']))
-@click.pass_obj
-def dump(ctx_obj, output_format):
-    """Dump the configuration to stdout"""
-    if output_format == 'yaml':
-        yaml.safe_dump(ctx_obj.to_dict(), sys.stdout)
-    else:
-        json.dump(ctx_obj.to_dict(), sys.stdout, indent=2)
-
-
-@config.command(['cat'])
-@click.pass_obj
-def env(ctx_obj):
-    """Print env vars. Use: eval "$(clarifai config env)" """
-    ctx_obj.current.print_env_vars()
+    print(f'Set {name} as the current context')
 
 
-@cli.command()
-@click.argument('api_url', default=DEFAULT_BASE)
-@click.option('--user_id', required=False, help='User ID')
+@config.command(aliases=['current-context'])
+@click.option('-o', '--output-format', default='name', type=click.Choice(['name', 'json', 'yaml']))
 @click.pass_context
-def login(ctx, api_url, user_id):
-    """Login command to set PAT and other configurations."""
-    from clarifai.utils.cli import validate_context_auth
-
-    name = input('context name (default: "default"): ')
-    user_id = user_id if user_id is not None else input('user id: ')
-    pat = input_or_default(
-        'personal access token value (default: "ENVVAR" to get our of env var rather than config): ',
-        'ENVVAR',
-    )
-
-    # Validate the Context Credentials
-    validate_context_auth(pat, user_id, api_url)
-
-    context = Context(
-        name,
-        CLARIFAI_API_BASE=api_url,
-        CLARIFAI_USER_ID=user_id,
-        CLARIFAI_PAT=pat,
-    )
-
-    if context.name == '':
-        context.name = 'default'
-
-    ctx.obj.contexts[context.name] = context
-    ctx.obj.current_context = context.name
-
-    ctx.obj.to_yaml()
-    logger.info(
-        f"Login successful and Configuration saved successfully for context '{context.name}'"
-    )
-
-
-@cli.group(cls=AliasedGroup)
-def context():
-    """Manage contexts"""
-
-
-def pat_display(pat):
-    return pat[:5] + "****"
-
-
-def input_or_default(prompt, default):
-    value = input(prompt)
-    return value if value else default
+def current_context(ctx, output_format):
+    """Show the current context's details."""
+    if output_format == 'name':
+        print(ctx.obj.current_context)
+    elif output_format == 'json':
+        print(json.dumps(ctx.obj.contexts[ctx.obj.current_context].to_serializable_dict()))
+    else:
+        print(yaml.safe_dump(ctx.obj.contexts[ctx.obj.current_context].to_serializable_dict()))
 
 
-@context.command()
+@config.command(aliases=['create-context', 'set-context'])
 @click.argument('name')
 @click.option('--user-id', required=False, help='User ID')
 @click.option('--base-url', required=False, help='Base URL')
 @click.option('--pat', required=False, help='Personal access token')
 @click.pass_context
-def create(
+def create_context(
     ctx,
     name,
     user_id=None,
     base_url=None,
     pat=None,
 ):
-    """Create a new context"""
+    """Create a new context."""
     from clarifai.utils.cli import validate_context_auth
 
     if name in ctx.obj.contexts:
@@ -234,22 +216,28 @@ def create(
             'personal access token value (default: "ENVVAR" to get our of env var rather than config): ',
             'ENVVAR',
         )
-
-    # Validate the Context Credentials
     validate_context_auth(pat, user_id, base_url)
-
     context = Context(name, CLARIFAI_USER_ID=user_id, CLARIFAI_API_BASE=base_url, CLARIFAI_PAT=pat)
     ctx.obj.contexts[context.name] = context
     ctx.obj.to_yaml()
     logger.info(f"Context '{name}' created successfully")
 
 
-# write a click command to delete a context
-@context.command(['rm'])
+@config.command(aliases=['e'])
+@click.pass_context
+def edit(
+    ctx,
+):
+    """Open the configuration file for editing."""
+    # For now, just open the config file (not per-context)
+    os.system(f'{os.environ.get("EDITOR", "vi")} {ctx.obj.filename}')
+
+
+@config.command(aliases=['delete-context'])
 @click.argument('name')
 @click.pass_context
-def delete(ctx, name):
-    """Delete a context"""
+def delete_context(ctx, name):
+    """Delete a context."""
     if name not in ctx.obj.contexts:
         print(f'{name} is not a valid context')
         sys.exit(1)
@@ -258,16 +246,29 @@ def delete(ctx, name):
     print(f'{name} deleted')
 
 
-@context.command()
-@click.argument('name', type=str)
+@config.command(aliases=['get-env'])
 @click.pass_context
-def use(ctx, name):
-    """Set the current context"""
-    if name not in ctx.obj.contexts:
-        raise click.UsageError('Context not found')
-    ctx.obj.current_context = name
-    ctx.obj.to_yaml()
-    print(f'Set {name} as the current context')
+def env(ctx):
+    """Print env vars for the active context."""
+    ctx.obj.current.print_env_vars()
+
+
+@config.command(aliases=['show'])
+@click.option('-o', '--output-format', default='yaml', type=click.Choice(['json', 'yaml']))
+@click.pass_context
+def view(ctx, output_format):
+    """Display the current configuration."""
+    config_dict = {
+        'current-context': ctx.obj.current_context,
+        'contexts': {
+            name: context.to_serializable_dict() for name, context in ctx.obj.contexts.items()
+        },
+    }
+
+    if output_format == 'json':
+        print(json.dumps(config_dict, indent=2))
+    else:
+        print(yaml.safe_dump(config_dict, default_flow_style=False))
 
 
 @cli.command()