|
1 | | -Vultr |
2 | | -===== |
3 | | -.. image:: https://travis-ci.org/spry-group/python-vultr.svg?branch=master |
4 | | - :target: https://travis-ci.org/spry-group/python-vultr |
| 1 | +# Vultr |
5 | 2 |
|
6 | | -Vultr provides a client library to the `Vultr.com <http://www.vultr.com/?ref=6989379-3B>` API. |
| 3 | +[](https://travis-ci.org/spry-group/python-vultr) |
7 | 4 |
|
8 | | -**Usage** |
| 5 | +Vultr provides a client library to the [Vultr.com](http://www.vultr.com/?ref=6989379-3B) API. |
9 | 6 |
|
10 | | -.. code:: python |
| 7 | +## Usage |
11 | 8 |
|
12 | | - api_key = 'XXXXXXXXX' |
13 | | - vultr = Vultr(api_key) |
14 | | - plans_json = vultr.plans.list() |
| 9 | +```python |
| 10 | +api_key = 'XXXXXXXXX' |
| 11 | +vultr = Vultr(api_key) |
| 12 | +plans_json = vultr.plans.list() |
| 13 | +``` |
15 | 14 |
|
| 15 | +## Testing |
16 | 16 |
|
17 | | -
|
18 | | -**Testing** |
19 | | - |
20 | | - From the repo root directory |
21 | | - Performs generic, unauthenticated tests |
22 | | - |
23 | | -.. code:: shell |
| 17 | +From the repo root directory |
| 18 | +Performs generic, unauthenticated tests |
24 | 19 |
|
25 | | - python -m unittest -v tests.test_vultr.UnauthenticatedTests |
26 | | -
|
| 20 | +```shell |
| 21 | +python -m unittest -v tests.test_vultr.UnauthenticatedTests |
| 22 | +``` |
27 | 23 |
|
28 | 24 | Requires the environment variable VULTR_KEY to be set |
29 | 25 |
|
30 | | -.. code:: shell |
31 | | -
|
32 | | - python -m unittest -v tests.test_vultr.AuthenticatedTests |
33 | | -
|
34 | | -
|
35 | | -**Support** |
| 26 | +```shell |
| 27 | +python -m unittest -v tests.test_vultr.AuthenticatedTests |
| 28 | +``` |
36 | 29 |
|
| 30 | +## Support |
37 | 31 |
|
38 | 32 | Python Vultr is supported on a volunteer basis. |
39 | 33 |
|
40 | | -* `Open an Issue <https://github.com/spry-group/python-vultr/issues/new>`_ |
41 | | - |
42 | | -* .. image:: https://badges.gitter.im/Join%20Chat.svg |
43 | | - :target: https://gitter.im/spry-group/python-vultr |
44 | | - |
| 34 | +* [Open an Issue](https://github.com/spry-group/python-vultr/issues/new) |
| 35 | +* [](https://gitter.im/spry-group/python-vultr) |
45 | 36 |
|
46 | | -**API** |
47 | 37 |
|
| 38 | +## API |
48 | 39 |
|
49 | 40 | * def account.info(self, params=None): |
50 | 41 | * def app.list(self, params=None): |
|
0 commit comments