diff --git a/keystoneclient/shell.py b/keystoneclient/shell.py index 401ff047..a4d8a1fb 100644 --- a/keystoneclient/shell.py +++ b/keystoneclient/shell.py @@ -94,7 +94,7 @@ class OpenStackIdentityShell(object): parser.add_argument('--version', action='version', version=keystoneclient.__version__, - help="Shows the client version and exits") + help="Shows the client version and exits.") parser.add_argument('--debug', default=False, @@ -105,14 +105,14 @@ class OpenStackIdentityShell(object): default=600, type=positive_non_zero_float, metavar='', - help="Set request timeout (in seconds)") + help="Set request timeout (in seconds).") parser.add_argument('--os-username', metavar='', default=env('OS_USERNAME'), help='Name used for authentication with the ' 'OpenStack Identity service. ' - 'Defaults to env[OS_USERNAME]') + 'Defaults to env[OS_USERNAME].') parser.add_argument('--os_username', help=argparse.SUPPRESS) @@ -121,7 +121,7 @@ class OpenStackIdentityShell(object): default=env('OS_PASSWORD'), help='Password used for authentication with the ' 'OpenStack Identity service. ' - 'Defaults to env[OS_PASSWORD]') + 'Defaults to env[OS_PASSWORD].') parser.add_argument('--os_password', help=argparse.SUPPRESS) @@ -129,7 +129,7 @@ class OpenStackIdentityShell(object): metavar='', default=env('OS_TENANT_NAME'), help='Tenant to request authorization on. ' - 'Defaults to env[OS_TENANT_NAME]') + 'Defaults to env[OS_TENANT_NAME].') parser.add_argument('--os_tenant_name', help=argparse.SUPPRESS) @@ -137,7 +137,7 @@ class OpenStackIdentityShell(object): metavar='', default=env('OS_TENANT_ID'), help='Tenant to request authorization on. ' - 'Defaults to env[OS_TENANT_ID]') + 'Defaults to env[OS_TENANT_ID].') parser.add_argument('--os_tenant_id', help=argparse.SUPPRESS) @@ -146,14 +146,15 @@ class OpenStackIdentityShell(object): default=env('OS_AUTH_URL'), help='Specify the Identity endpoint to use for ' 'authentication. ' - 'Defaults to env[OS_AUTH_URL]') + 'Defaults to env[OS_AUTH_URL].') parser.add_argument('--os_auth_url', help=argparse.SUPPRESS) parser.add_argument('--os-region-name', metavar='', default=env('OS_REGION_NAME'), - help='Defaults to env[OS_REGION_NAME]') + help='Specify the region to use. ' + 'Defaults to env[OS_REGION_NAME].') parser.add_argument('--os_region_name', help=argparse.SUPPRESS) @@ -161,8 +162,9 @@ class OpenStackIdentityShell(object): metavar='', default=env('OS_IDENTITY_API_VERSION', 'KEYSTONE_VERSION'), - help='Defaults to env[OS_IDENTITY_API_VERSION]' - ' or 2.0') + help='Specify Identity API version to use. ' + 'Defaults to env[OS_IDENTITY_API_VERSION]' + ' or 2.0.') parser.add_argument('--os_identity_api_version', help=argparse.SUPPRESS) @@ -172,7 +174,7 @@ class OpenStackIdentityShell(object): help='Specify an existing token to use instead of ' 'retrieving one via authentication (e.g. ' 'with username & password). ' - 'Defaults to env[OS_SERVICE_TOKEN]') + 'Defaults to env[OS_SERVICE_TOKEN].') parser.add_argument('--os-endpoint', metavar='', @@ -180,14 +182,14 @@ class OpenStackIdentityShell(object): help='Specify an endpoint to use instead of ' 'retrieving one from the service catalog ' '(via authentication). ' - 'Defaults to env[OS_SERVICE_ENDPOINT]') + 'Defaults to env[OS_SERVICE_ENDPOINT].') parser.add_argument('--os-cacert', metavar='', default=env('OS_CACERT', default=None), help='Specify a CA bundle file to use in ' 'verifying a TLS (https) server certificate. ' - 'Defaults to env[OS_CACERT]') + 'Defaults to env[OS_CACERT].') parser.add_argument('--os_cacert', help=argparse.SUPPRESS) @@ -203,14 +205,14 @@ class OpenStackIdentityShell(object): parser.add_argument('--os-cert', metavar='', default=env('OS_CERT'), - help='Defaults to env[OS_CERT]') + help='Defaults to env[OS_CERT].') parser.add_argument('--os_cert', help=argparse.SUPPRESS) parser.add_argument('--os-key', metavar='', default=env('OS_KEY'), - help='Defaults to env[OS_KEY]') + help='Defaults to env[OS_KEY].') parser.add_argument('--os_key', help=argparse.SUPPRESS) @@ -218,7 +220,7 @@ class OpenStackIdentityShell(object): default=env('OS_CACHE', default=False), action='store_true', help='Use the auth token cache. ' - 'Defaults to env[OS_CACHE]') + 'Defaults to env[OS_CACHE].') parser.add_argument('--os_cache', help=argparse.SUPPRESS) @@ -457,7 +459,7 @@ class OpenStackIdentityShell(object): print(' '.join(commands | options)) @utils.arg('command', metavar='', nargs='?', - help='Display help for ') + help='Display help for .') def do_help(self, args): """Display help about this program or one of its subcommands.""" if getattr(args, 'command', None): diff --git a/keystoneclient/v2_0/shell.py b/keystoneclient/v2_0/shell.py index d738ee95..087d3ed5 100755 --- a/keystoneclient/v2_0/shell.py +++ b/keystoneclient/v2_0/shell.py @@ -47,7 +47,7 @@ def require_service_catalog(f): @utils.arg('--tenant', '--tenant-id', metavar='', - help='Tenant; lists all users if not specified') + help='Tenant; lists all users if not specified.') @utils.arg('--tenant_id', help=argparse.SUPPRESS) def do_user_list(kc, args): """List users.""" @@ -60,7 +60,7 @@ def do_user_list(kc, args): order_by='name') -@utils.arg('user', metavar='', help='Name or ID of user to display') +@utils.arg('user', metavar='', help='Name or ID of user to display.') def do_user_get(kc, args): """Display user details.""" user = utils.find_resource(kc.users, args.user) @@ -68,16 +68,16 @@ def do_user_get(kc, args): @utils.arg('--name', metavar='', required=True, - help='New user name (must be unique)') + help='New user name (must be unique).') @utils.arg('--tenant', '--tenant-id', metavar='', - help='New user default tenant') + help='New user default tenant.') @utils.arg('--tenant_id', help=argparse.SUPPRESS) @utils.arg('--pass', metavar='', dest='passwd', nargs='?', - const=ASK_FOR_PASSWORD, help='New user password') + const=ASK_FOR_PASSWORD, help='New user password.') @utils.arg('--email', metavar='', - help='New user email address') + help='New user email address.') @utils.arg('--enabled', metavar='', default=True, - help='Initial user enabled status (default true)') + help='Initial user enabled status. Default is true.') def do_user_create(kc, args): """Create new user""" if args.tenant: @@ -96,12 +96,12 @@ def do_user_create(kc, args): @utils.arg('--name', metavar='', - help='Desired new user name') + help='Desired new user name.') @utils.arg('--email', metavar='', - help='Desired new email address') + help='Desired new email address.') @utils.arg('--enabled', metavar='', - help='Enable or disable user') -@utils.arg('user', metavar='', help='Name or ID of user to update') + help='Enable or disable user.') +@utils.arg('user', metavar='', help='Name or ID of user to update.') def do_user_update(kc, args): """Update user's name, email, and enabled status.""" kwargs = {} @@ -125,9 +125,9 @@ def do_user_update(kc, args): @utils.arg('--pass', metavar='', dest='passwd', required=False, - help='Desired new password') + help='Desired new password.') @utils.arg('user', metavar='', - help='Name or ID of user to update password') + help='Name or ID of user to update password.') def do_user_password_update(kc, args): """Update user password.""" user = utils.find_resource(kc.users, args.user) @@ -142,9 +142,9 @@ def do_user_password_update(kc, args): @utils.arg('--current-password', metavar='', dest='currentpasswd', required=False, help='Current password, ' 'Defaults to the password as set by --os-password or ' - 'OS_PASSWORD') + 'env[OS_PASSWORD].') @utils.arg('--new-password ', metavar='', dest='newpasswd', - required=False, help='Desired new password') + required=False, help='Desired new password.') def do_password_update(kc, args): """Update own password.""" @@ -171,9 +171,9 @@ def do_password_update(kc, args): "to match your new password") -@utils.arg('user', metavar='', help='Name or ID of user to delete') +@utils.arg('user', metavar='', help='Name or ID of user to delete.') def do_user_delete(kc, args): - """Delete user""" + """Delete user.""" user = utils.find_resource(kc.users, args.user) kc.users.delete(user) @@ -185,7 +185,7 @@ def do_tenant_list(kc, args): @utils.arg('tenant', metavar='', - help='Name or ID of tenant to display') + help='Name or ID of tenant to display.') def do_tenant_get(kc, args): """Display tenant details.""" tenant = utils.find_resource(kc.tenants, args.tenant) @@ -193,11 +193,11 @@ def do_tenant_get(kc, args): @utils.arg('--name', metavar='', required=True, - help='New tenant name (must be unique)') + help='New tenant name (must be unique).') @utils.arg('--description', metavar='', default=None, - help='Description of new tenant (default is none)') + help='Description of new tenant. Default is none.') @utils.arg('--enabled', metavar='', default=True, - help='Initial tenant enabled status (default true)') + help='Initial tenant enabled status. Default is true.') def do_tenant_create(kc, args): """Create new tenant.""" tenant = kc.tenants.create(args.name, @@ -207,12 +207,13 @@ def do_tenant_create(kc, args): @utils.arg('--name', metavar='', - help='Desired new name of tenant') + help='Desired new name of tenant.') @utils.arg('--description', metavar='', default=None, - help='Desired new description of tenant') + help='Desired new description of tenant.') @utils.arg('--enabled', metavar='', - help='Enable or disable tenant') -@utils.arg('tenant', metavar='', help='Name or ID of tenant to update') + help='Enable or disable tenant.') +@utils.arg('tenant', metavar='', + help='Name or ID of tenant to update.') def do_tenant_update(kc, args): """Update tenant name, description, enabled status.""" tenant = utils.find_resource(kc.tenants, args.tenant) @@ -230,7 +231,8 @@ def do_tenant_update(kc, args): tenant.update(**kwargs) -@utils.arg('tenant', metavar='', help='Name or ID of tenant to delete') +@utils.arg('tenant', metavar='', + help='Name or ID of tenant to delete.') def do_tenant_delete(kc, args): """Delete tenant.""" tenant = utils.find_resource(kc.tenants, args.tenant) @@ -238,12 +240,12 @@ def do_tenant_delete(kc, args): @utils.arg('--name', metavar='', required=True, - help='Name of new service (must be unique)') + help='Name of new service (must be unique).') @utils.arg('--type', metavar='', required=True, help='Service type (one of: identity, compute, network, ' - 'image, object-store, or other service identifier string)') + 'image, object-store, or other service identifier string).') @utils.arg('--description', metavar='', - help='Description of service') + help='Description of service.') def do_service_create(kc, args): """Add service to Service Catalog.""" service = kc.services.create(args.name, @@ -260,7 +262,7 @@ def do_service_list(kc, args): @utils.arg('service', metavar='', - help='Name or ID of service to display') + help='Name or ID of service to display.') def do_service_get(kc, args): """Display service from Service Catalog.""" service = utils.find_resource(kc.services, args.service) @@ -268,7 +270,7 @@ def do_service_get(kc, args): @utils.arg('service', metavar='', - help='Name or ID of service to delete') + help='Name or ID of service to delete.') def do_service_delete(kc, args): """Delete service from Service Catalog.""" service = utils.find_resource(kc.services, args.service) @@ -281,7 +283,7 @@ def do_role_list(kc, args): utils.print_list(roles, ['id', 'name'], order_by='name') -@utils.arg('role', metavar='', help='Name or ID of role to display') +@utils.arg('role', metavar='', help='Name or ID of role to display.') def do_role_get(kc, args): """Display role details.""" role = utils.find_resource(kc.roles, args.role) @@ -289,14 +291,14 @@ def do_role_get(kc, args): @utils.arg('--name', metavar='', required=True, - help='Name of new role') + help='Name of new role.') def do_role_create(kc, args): """Create new role.""" role = kc.roles.create(args.name) utils.print_dict(role._info) -@utils.arg('role', metavar='', help='Name or ID of role to delete') +@utils.arg('role', metavar='', help='Name or ID of role to delete.') def do_role_delete(kc, args): """Delete role.""" role = utils.find_resource(kc.roles, args.role) @@ -304,14 +306,14 @@ def do_role_delete(kc, args): @utils.arg('--user', '--user-id', '--user_id', metavar='', - required=True, help='Name or ID of user') + required=True, help='Name or ID of user.') @utils.arg('--role', '--role-id', '--role_id', metavar='', - required=True, help='Name or ID of role') + required=True, help='Name or ID of role.') @utils.arg('--tenant', '--tenant-id', metavar='', - help='Name or ID of tenant') + help='Name or ID of tenant.') @utils.arg('--tenant_id', help=argparse.SUPPRESS) def do_user_role_add(kc, args): - """Add role to user""" + """Add role to user.""" user = utils.find_resource(kc.users, args.user) role = utils.find_resource(kc.roles, args.role) if args.tenant: @@ -324,14 +326,14 @@ def do_user_role_add(kc, args): @utils.arg('--user', '--user-id', '--user_id', metavar='', - required=True, help='Name or ID of user') + required=True, help='Name or ID of user.') @utils.arg('--role', '--role-id', '--role_id', metavar='', - required=True, help='Name or ID of role') + required=True, help='Name or ID of role.') @utils.arg('--tenant', '--tenant-id', metavar='', - help='Name or ID of tenant') + help='Name or ID of tenant.') @utils.arg('--tenant_id', help=argparse.SUPPRESS) def do_user_role_remove(kc, args): - """Remove role from user""" + """Remove role from user.""" user = utils.find_resource(kc.users, args.user) role = utils.find_resource(kc.roles, args.role) if args.tenant: @@ -344,13 +346,13 @@ def do_user_role_remove(kc, args): @utils.arg('--user', '--user-id', metavar='', - help='List roles granted to a user') + help='List roles granted to specified user.') @utils.arg('--user_id', help=argparse.SUPPRESS) @utils.arg('--tenant', '--tenant-id', metavar='', - help='List roles granted on a tenant') + help='List only roles granted on specified tenant.') @utils.arg('--tenant_id', help=argparse.SUPPRESS) def do_user_role_list(kc, args): - """List roles granted to a user""" + """List roles granted to a user.""" if args.tenant: tenant_id = utils.find_resource(kc.tenants, args.tenant).id elif args.tenant_id: @@ -377,9 +379,13 @@ def do_user_role_list(kc, args): order_by='name') -@utils.arg('--user-id', metavar='', help='User ID') +@utils.arg('--user-id', metavar='', + help='User ID for which to create credentials. If not specified, ' + 'the authenticated user will be used.') @utils.arg('--user_id', help=argparse.SUPPRESS) -@utils.arg('--tenant-id', metavar='', help='Tenant ID') +@utils.arg('--tenant-id', metavar='', + help='Tenant ID for which to to create credentials. If not ' + 'specified, the authenticated tenant ID will be used.') @utils.arg('--tenant_id', help=argparse.SUPPRESS) def do_ec2_credentials_create(kc, args): """Create EC2-compatible credentials for user per tenant.""" @@ -393,10 +399,10 @@ def do_ec2_credentials_create(kc, args): utils.print_dict(credentials._info) -@utils.arg('--user-id', metavar='', help='User ID') +@utils.arg('--user-id', metavar='', help='User ID.') @utils.arg('--user_id', help=argparse.SUPPRESS) @utils.arg('--access', metavar='', required=True, - help='Access Key') + help='Access Key.') def do_ec2_credentials_get(kc, args): """Display EC2-compatible credentials.""" if not args.user_id: @@ -407,10 +413,10 @@ def do_ec2_credentials_get(kc, args): utils.print_dict(cred._info) -@utils.arg('--user-id', metavar='', help='User ID') +@utils.arg('--user-id', metavar='', help='User ID.') @utils.arg('--user_id', help=argparse.SUPPRESS) def do_ec2_credentials_list(kc, args): - """List EC2-compatible credentials for a user""" + """List EC2-compatible credentials for a user.""" if not args.user_id: # use the authenticated user id as a default args.user_id = kc.auth_user_id @@ -425,10 +431,10 @@ def do_ec2_credentials_list(kc, args): utils.print_list(credentials, ['tenant', 'access', 'secret']) -@utils.arg('--user-id', metavar='', help='User ID') +@utils.arg('--user-id', metavar='', help='User ID.') @utils.arg('--user_id', help=argparse.SUPPRESS) @utils.arg('--access', metavar='', required=True, - help='Access Key') + help='Access Key.') def do_ec2_credentials_delete(kc, args): """Delete EC2-compatible credentials.""" if not args.user_id: @@ -442,7 +448,7 @@ def do_ec2_credentials_delete(kc, args): @utils.arg('--service', metavar='', default=None, - help='Service type to return') + help='Service type to return.') @require_service_catalog def do_catalog(kc, args): """List service catalog, possibly filtered by service.""" @@ -455,15 +461,15 @@ def do_catalog(kc, args): @utils.arg('--service', metavar='', required=True, - help='Service type to select') + help='Service type to select.') @utils.arg('--endpoint-type', metavar='', default='publicURL', - help='Endpoint type to select') + help='Endpoint type to select.') @utils.arg('--endpoint_type', default='publicURL', help=argparse.SUPPRESS) @utils.arg('--attr', metavar='', - help='Service attribute to match for selection') + help='Service attribute to match for selection.') @utils.arg('--value', metavar='', - help='Value of attribute to match') + help='Value of attribute to match.') @require_service_catalog def do_endpoint_get(kc, args): """Find endpoint filtered by a specific attribute or service type.""" @@ -491,16 +497,16 @@ def do_endpoint_list(kc, args): @utils.arg('--region', metavar='', - help='Endpoint region', default='regionOne') + help='Endpoint region.', default='regionOne') @utils.arg('--service', '--service-id', '--service_id', metavar='', required=True, - help='Name or ID of service associated with Endpoint') + help='Name or ID of service associated with endpoint.') @utils.arg('--publicurl', metavar='', required=True, - help='Public URL endpoint') + help='Public URL endpoint.') @utils.arg('--adminurl', metavar='', - help='Admin URL endpoint') + help='Admin URL endpoint.') @utils.arg('--internalurl', metavar='', - help='Internal URL endpoint') + help='Internal URL endpoint.') def do_endpoint_create(kc, args): """Create a new endpoint associated with a service.""" service_id = utils.find_resource(kc.services, args.service).id @@ -512,7 +518,7 @@ def do_endpoint_create(kc, args): utils.print_dict(endpoint._info) -@utils.arg('id', metavar='', help='ID of endpoint to delete') +@utils.arg('id', metavar='', help='ID of endpoint to delete.') def do_endpoint_delete(kc, args): """Delete a service endpoint.""" try: @@ -523,7 +529,7 @@ def do_endpoint_delete(kc, args): @utils.arg('--wrap', metavar='', default=0, - help='wrap PKI tokens to a specified length, or 0 to disable') + help='Wrap PKI tokens to a specified length, or 0 to disable.') @require_service_catalog def do_token_get(kc, args): """Display the current user token."""