plantpy 0.0.1

Plant Village Survey Export: Simple CLI

plantpy: Plant Village Survey Export Simple CLI

This is an application to programmatically export Survey results from Plant Village surveys. The tool will be extended to include multiple surveys and data sources but for now it exports only the Locust survey datasets. This tools access will depend on your access with plantvillage.

Table of contents

• Installation
• Getting started
  • plantpy auth
  • plantpy locust

Installation

This assumes that you have native python3 & pip installed in your system, you can test this by going to the terminal (or windows command prompt) and trying

python and then pip list

To install Plant Village Simple CLI for Survey Access you can install using two methods.

pip install plantpy

or you can also try

git clone https://github.com/samapriya/plantpy.git
cd plantpy
python setup.py install

For Linux use sudo or try pip install plantpy --user.

I recommend installation within a virtual environment.

Getting started

As usual, to print help:

plantpy -h
usage: plantpy [-h] {auth,locust} ...

Plant Village Survey Export: Simple CLI

positional arguments:
  {auth,locust}
    auth         Saves your username and password
    locust       Extract locust survey data

optional arguments:
  -h, --help     show this help message and exit

To obtain help for specific functionality, simply call it with help switch, e.g.: plantpy auth -h.

plantpy auth

For now this stores the username and password as a JSON file which eliminates the need for users to input authentication details again and again. It has some inherent features, it looks for your country in existing country list and will let you know if returned CSV is empty.

plantpy auth -h
usage: plantpy auth [-h]

optional arguments:
  -h, --help  show this help message and exit

---

plantpy locust

This allows you to export the locust reports based on country, start and end date into a CSV file. Usage is simply

plantpy locust -h
usage: plantpy locust [-h] --start START --end END --country COUNTRY --report
                      REPORT

optional arguments:
  -h, --help         show this help message and exit

Required named arguments.:
  --start START      Start Date YYYY-MM-DD
  --end END          End date YYYY-MM-DD
  --country COUNTRY  Select country to get data
  --report REPORT    full path to CSV report file