Metadata-Version: 2.1
Name: appknox
Version: 3.1.4
Summary: Command-line interface & Python wrapper for the Appknox API
Home-page: https://github.com/appknox/appknox-python
Author: Appknox
Author-email: engineering@appknox.com
License: MIT
Description: [![PyPI version](https://badge.fury.io/py/appknox.svg)](https://badge.fury.io/py/appknox)
        [![Build Status](https://travis-ci.org/appknox/appknox-python.svg)](https://travis-ci.org/appknox/appknox-python)
        [![Join the chat at https://gitter.im/appknox/appknox-python](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/appknox/appknox-python?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
        
        # appknox-python
        
        Command-line interface & Python wrapper for the Appknox API.
        
        
        >
        > Python API documentation is available [here](http://appknox.org/appknox-python/).
        >
        
        
        ## Installation
        
        appknox-python is officially supported on python 3.5 & 3.6. pip is the recommended way to install appknox-python.
        
        ```
        pip install appknox
        ```
        
        ## Usage
        
        ```
        $ appknox
        Usage: appknox [OPTIONS] COMMAND [ARGS]...
        
          Command line wrapper for the Appknox API
        
        Options:
          -v, --verbose  Specify log verbosity.
          --help         Show this message and exit.
        
        Commands:
          analyses       List analyses for file
          files          List files for project
          login          Log in and save session credentials
          logout         Delete session credentials
          organizations  List organizations
          projects       List projects
          report         Download report for file
          upload         Upload and scan package
          switch_organization  Switch organization in CLI instance
          vulnerability  Get vulnerability
          whoami         Show session info
        ```
        
        ### Authentication
        
        Log in to appknox CLI using your [secure.appknox.com](https://secure.appknox.com/) credentials.
        
        ```
        $ appknox login
        Username: viren
        Password:
        Logged in to https://api.appknox.com
        ```
        
        #### Using Environment Variables
        
        Instead of `login` we can use environment variables for authentication. This will be useful for scenarios such as CI/CD setup.
        
        ```
        $ export APPKNOX_ACCESS_TOKEN=aaaabbbbbcccddeeeffgghhh
        $ export APPKNOX_ORGANIZATION_ID=2
        ```
        
        Supported variables are:
        
        | Environment variable | Value |
        |----|-----|
        | `APPKNOX_ACCESS_TOKEN` | Access token can be generated from Appknox dashboard _(Settings → Developer Settings → Generate token)_. |
        | `APPKNOX_HOST` | Defaults to `https://api.appknox.com` |
        | `APPKNOX_ORGANIZATION_ID` | Your Appknox organization id |
        
        
        ### Data fetch & actions
        
        | Available commands | Use |
        |--------------------|-----|
        | `organizations` | List organizations of user |
        | `projects` | List projects user has access to |
        | `files <project_id>` | List files for a project |
        | `analyses <file_id>` | List analyses for a file |
        | `vulnerability <vulnerability_id>` | Get vulnerability detail |
        | `owasp <owasp_id>` | Get OWASP detail |
        | `upload <path_to_app_package>` | Upload app file from given path |
        | `rescan <file_id>` | Rescan a file (this will create a new file under the same project.) |
        
        
        Example:
        
        ```
        $ appknox organizations
          id  name
        ----  -------
           2  MyOrganization
        
        $ appknox projects
          id  created_on             file_count  package_name                     platform  updated_on
        ----  -------------------  ------------  -----------------------------  ----------  -------------------
           3  2017-06-23 07:19:26             3  org.owasp.goatdroid.fourgoats           0  2017-06-23 07:26:55
           4  2017-06-27 08:27:54             2  com.appknox.mfva                        0  2017-06-27 08:30:04
        
        $ appknox files 4
          id  name      version    version_code
        ----  ------  ---------  --------------
           6  MFVA            1               6
           7  MFVA            1               6
        ```
        
        ---
        
        ## Development
        ### Update docs
        
        Install [sphinx-autobuild](https://github.com/GaretJax/sphinx-autobuild):
        ```
        pip install sphinx-autobuild
        ```
        
        Build docs:
        ```
        sphinx-autobuild -p 9009 -b html sphinx-docs docs
        ```
        
        ---
        
        License: MIT
        
Keywords: appknox xysec rest api wrapper cli mobile security
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: test
