Metadata-Version: 2.0
Name: appknox
Version: 0.0.4
Summary: Python wrapper for Appknox's REST API
Home-page: https://github.com/appknox/appknox-python
Author: dhilipsiva
Author-email: dhilipsiva@gmail.com
License: MIT
Keywords: appknox xysec rest api wrapper
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Requires-Dist: requests
Requires-Dist: click
Provides-Extra: dev
Provides-Extra: test

# appknox-python
Python wrapper for Appknox's REST API

## Installation
`[sudo] pip install appknox`

## Usage

### Credentials
***Method 1***

You can either specify credentials in your `ENV` variables `APPKNOX_USERNAME` & `APPKNOX_PASSWORD`
```
export APPKNOX_USERNAME="YourUseranme"
export APPKNOX_PASSWORD="YourPassword"
```
to check if it is properly configured, just do `appknox validate`

***Method 2***

You can aslo pass it as an option.

`appknox --username YourUseranme --password YourPassword validate`

Method-1 is recommended because its more clean. From this point forward, the documentation will give examples assuming you have used Method-1. You just have to pass `--username YourUseranme --password YourPassword` after `appknox` if you opt for method-2.

### Submit a store URL

```
appknox submit_url "<Your store URL Goes here>"
```

### Uploading your app

```
appknox upload /path/to/your/android.apk
appknox upload /path/to/your/ios.ipa
```

### Help
```
appknox --help
```


## Todo

- [x] Authentication
- [x] Authorization
- [ ] Versioning
- [x] Submit URL
- [x] Upload File
- [ ] Projects
    - [ ] List
    - [ ] Get
    - [ ] Delete
- [ ] Files
    - [ ] List
    - [ ] Get
    - [ ] Delete
- [ ] Analyses
    - [ ] List
- [ ] Reports
    - [ ] PDF
    - [ ] JSON
    - [ ] XML
    - [ ] CSV
- [ ] Hooks
    - [ ] Create
    - [ ] Edit
    - [ ] Delete


