Tres Seaver | 623d5d2 | 2014-11-20 11:23:03 -0500 | [diff] [blame] | 1 | google-apitools |
| 2 | =============== |
| 3 | |
Danny Hermes | 9a0e3ca | 2015-03-24 18:15:51 -0700 | [diff] [blame] | 4 | |pypi| |build| |coverage| |
Tres Seaver | 623d5d2 | 2014-11-20 11:23:03 -0500 | [diff] [blame] | 5 | |
| 6 | ``google-apitools`` is a collection of utilities to make it easier to build |
| 7 | client-side tools, especially those that talk to Google APIs. |
| 8 | |
Craig Citro | cb4dce4 | 2015-02-17 17:00:51 -0800 | [diff] [blame] | 9 | **NOTE**: This library is stable, but in maintenance mode, and not under |
| 10 | active development. However, any bugs or security issues will be fixed |
| 11 | promptly. |
| 12 | |
Tres Seaver | 623d5d2 | 2014-11-20 11:23:03 -0500 | [diff] [blame] | 13 | Installing as a library |
| 14 | ----------------------- |
| 15 | |
| 16 | To install the library into the current virtual environment:: |
| 17 | |
| 18 | $ pip install google-apitools |
| 19 | |
| 20 | Installing the command-line tools |
| 21 | --------------------------------- |
| 22 | |
| 23 | To install the command-line scripts into the current virtual environment:: |
| 24 | |
| 25 | $ pip install google-apitools[cli] |
| 26 | |
| 27 | Running the tests |
| 28 | ----------------- |
| 29 | |
| 30 | First, install the testing dependencies:: |
| 31 | |
| 32 | $ pip install google-apitools[testing] |
| 33 | |
| 34 | and the ``nose`` testrunner:: |
| 35 | |
| 36 | $ pip install nose |
| 37 | |
| 38 | Then run the tests:: |
| 39 | |
| 40 | $ nosetests |
Danny Hermes | b5d4d5b | 2015-03-24 10:59:28 -0700 | [diff] [blame] | 41 | |
| 42 | .. |build| image:: https://travis-ci.org/google/apitools.svg?branch=master |
| 43 | :target: https://travis-ci.org/google/apitools |
| 44 | .. |pypi| image:: https://img.shields.io/pypi/v/google-apitools.svg |
| 45 | :target: https://pypi.python.org/pypi/google-apitools |
Craig Citro | 0a34934 | 2015-05-24 14:28:59 -0700 | [diff] [blame] | 46 | .. |coverage| image:: https://coveralls.io/repos/google/apitools/badge.svg?branch=master |
Danny Hermes | 9a0e3ca | 2015-03-24 18:15:51 -0700 | [diff] [blame] | 47 | :target: https://coveralls.io/r/google/apitools?branch=master |