Metadata-Version: 2.1
Name: appknox
Version: 3.1.0
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
        ```
        
        ## Quickstart
        
        ```
        $ appknox login
        Username: viren
        Password:
        Logged in to https://api.appknox.com
        
        $ 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
        ```
        
        ## Usage
        
        ```
        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
        ```
        
        ## Using Environment Variables
        
        We can use Environment Variables instead of passing sensitive information via arguments for CI/CD setup
        
        ```
        export APPKNOX_ACCESS_TOKEN=aaaabbbbbcccddeeeffgghhh
        export APPKNOX_HOST=https://api.appknox.com
        export APPKNOX_ORGANIZATION_ID=1
        ```
        ---
        
        ### 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
