Metadata-Version: 1.1
Name: google-oauth2l
Version: 0.9.0
Summary: command-line google oauth tools
Home-page: http://github.com/google/oauth2l
Author: Craig Citro
Author-email: craigcitro@google.com
License: Apache 2.0
Description: oauth2l
        -------
        
        [![Build Status](https://travis-ci.org/google/oauth2l.svg?branch=master)](https://travis-ci.org/google/oauth2l)
        [![Coverage](https://coveralls.io/repos/google/oauth2l/badge.svg?branch=master)](https://coveralls.io/r/google/oauth2l?branch=master)
        [![PyPI](https://img.shields.io/pypi/v/google-oauth2l.svg)](https://pypi.python.org/pypi/google-oauth2l)
        [![Versions](https://img.shields.io/pypi/pyversions/google-oauth2l.svg)](https://pypi.python.org/pypi/google-oauth2l)
        
        `oauth2l` (pronounced "oauth tool") is a simple command-line tool that can be
        used to interact with Google OAuth system. Its primary use is to fetch and
        print OAuth 2.0 access tokens, which can be used with other command-line
        tools and shell scripts.
        
        ## Overview
        
        `oauth2l` supports multiple OAuth 2.0 authentication flows for both user
        accounts and service accounts:
        
        * When running inside Google Compute Engine (GCE) and Google Container
        Engine (GKE), it uses the credentials of the current GCE service account
        (if it exists).
        
        * When running inside user context that has an active Google Cloud SDK
        (gcloud) session, it uses the gcloud credential.
        
        * When running with command line flag `--json xxx`, where `xxx` points to a
        JSON credential file -- either a service account or an OAuth client id --
        downloaded from Google API Console, `oauth2l` will use the JSON file to start
        the OAuth session.
        
        * Otherwise, `oauth2l` will use its own OAuth client id to start the OAuth
        session.
        
        NOTE: `oauth2l` will cache the OAuth credential until its expiration to avoid
        prompting user repeatedly.
        
        ## Install
        
            pip install google-oauth2l
        
        ## Commands
        
        ### fetch
        
        Fetch and print an access token for the specified OAuth scopes. For example,
        the following command prints access token for the following OAuth2 scopes:
        
        * https://www.googleapis.com/auth/userinfo.email
        * https://www.googleapis.com/auth/cloud-platform
        
        ```
        $ oauth2l fetch -f bare userinfo.email cloud-platform
        ya29.zyxwvutsrqpnmolkjihgfedcba
        ```
        
        ### header
        
        Same as `fetch`, except that we print the token in HTTP header format:
        
        ```
        $ oauth2l header userinfo.email
        Authorization: Bearer ya29.zyxwvutsrqpnmolkjihgfedcba
        ```
        
        The `header` command is designed to be easy to use with `curl`. For example,
        the following command uses the BigQuery API to list all projects.
        
        ```
        $ curl -H "$(oauth2l header bigquery)" 'https://www.googleapis.com/bigquery/v2/projects'
        ```
        
        If you need to call Google APIs frequently using the `header` command, you
        might define a shell alias for it, for example:
        
        ```
        $ alias gcurl='curl -H "$(oauth2l header cloud-platform)" -H "Content-Type: application/json" '
        $ gcurl 'https://www.googleapis.com/bigquery/v2/projects'
        ```
        
        ### info
        
        Print information about a valid token. This always includes the list of scopes
        and expiration time. If the token has either the
        `https://www.googleapis.com/auth/userinfo.email` or
        `https://www.googleapis.com/auth/plus.me` scope, it also prints the email
        address of the authenticated identity.
        
        ```
        $ oauth2l info $(oauth2l fetch -f bare bigquery)
        {
            "expires_in": 3599,
            "scope": "https://www.googleapis.com/auth/bigquery",
            "email": "user@gmail.com"
        }
        ```
        
        NOTE: The actual output may have a few more fields.
        
        ### test
        
        Test a token. This sets an exit code of 0 for a valid token and 1 otherwise,
        which can be useful in shell pipelines.
        
        ```
        $ oauth2l test ya29.zyxwvutsrqpnmolkjihgfedcba
        $ echo $?
        0
        $ oauth2l test ya29.justkiddingmadethisoneup
        $ echo $?
        1
        ```
        
Keywords: apitools
Platform: UNKNOWN
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
