gro-intelligence/api-client

Gro Intelligence API Client

api-client's Issues

API_HOST is undefined in api/client/samples/crop_models/sugar.py

Undefined variable in crop_models.py

Partner_region is undefined, causing this error:

Traceback (most recent call last): File "sugar.py", line 68, in <module> main() File "sugar.py", line 46, in main model.add_data_series(item="sugarcane", metric="production quantity", region="Brazil", partner_region="Kenya") File "/home/james/git/gro/api/client/samples/crop_models/crop_model.py", line 49, in add_data_series kwargs['partner_region'], partner_region) NameError: global name 'partner_region' is not defined

Move {unix,windows}-setup.md into docs/

Don't see a need for the separate unix-setup.md and windows-setup.md, seems worthwhile to merge these into the docs/ and have them on developers.gro-intelligence.com.

In fact, it seems like we already have docs on this, so perhaps we can just remove these files and change the README.md links: https://developers.gro-intelligence.com/prerequisites/software-packages-prereqs

Error when attempting to call model.get_df() with an empty list of data series

This exception is raised when model.get_data_series_list() returns and empty list.

Traceback (most recent call last): File "sugar.py", line 69, in <module> main() File "sugar.py", line 64, in main data_frame = model.get_df() File "/home/james/git/api-client/api/client/samples/crop_models/crop_model.py", line 18, in get_df for series in self._data_series_list) File "/usr/local/lib/python2.7/dist-packages/pandas/core/reshape/concat.py", line 212, in concat copy=copy) File "/usr/local/lib/python2.7/dist-packages/pandas/core/reshape/concat.py", line 245, in __init__ raise ValueError('No objects to concatenate') ValueError: No objects to concatenate

import issue with brazil_soybeans.ipynb

The import needs to be changed to
from groclient.crop_model import CropModel.

https://github.com/gro-intelligence/api-client/blob/development/api/client/samples/crop_models/brazil_soybeans.ipynb

README.pdf not very useful

The format looks weird.
You cannot copy-paste from the PDF.

I would provide a text version of it, or better, a Jupyter notebook version of it.

Provide a setup.py file

By packaging the api-client the correct, we can install our SDK using pip from github.

See pypa/pip#3610,
https://docs.python.org/2/distutils/setupscript.html

Add Sphinx correctness checking for our docs to CI

• Make sure latest docs build without errors
  • Use -n for nitpicky mode. Generates some warnings about bad links we should fix.
• Consider checking validity of links? (sphinx-build -b linkcheck docs docs/_build/linkcheck)
  • Sphinx 3.2.0 added checking for local links, which causes a bunch of false positives. Think we can fix by using references instead of links.