document the use of yapf for formatting
2 files changed
tree: 2ad38a1e8795e0b2795cdfddf3a6d8d737522f0b
  1. .flake8
  2. .gitignore
  3. .python-version
  4. .style.yapf
  5. CONTRIBUTING.md
  6. LICENSE
  7. README.md
  8. client.py
  9. csv_uploader.py
  10. list_instances.py
  11. list_tasks.py
  12. sample.csv
README.md

The Google Code-in API Client

API Documentation is at https://developers.google.com/open-source/gci/api

Usage

./list_tasks.py --apikey APIKEY

./list_instances.py --apikey APIKEY

./csv_uploader.py --apikey APIKEY file.csv

Each script also supports other flags. Use --help to see them.

Prerequisites

The client library requires requests to be installed.

You can install it with pip or easy_install (instructions) or install your operating system specific package. On Ubuntu or Debian, it is in the python-requests package.

API Keys

Organization Adminstrators can find their API key on their User Profile.

Code Style

We follow the Google Python Style Guide with a few modifications to match the Google internal version. The primary one is the use of 2 space indents.

Use yapf to keep the code formatted nicely. You can set up an auto-save hook in your editor, or run it manually:

# one time setup:
pip install yapf

# format files:
yapf -i *.py

Bugs/Support

To report bugs, please email gci-support@google.com.