Merge pull request #45 from spry-group/master

Release Candidate

Author: dopry

.gitignore

@@ -5,3 +5,5 @@ Lib
 Scripts
 *.egg-info
 *.pyc
+
+venv

.travis.yml

@@ -1,9 +1,9 @@
 language: python
 python:
   - "2.7"
-  - "3.2"
   - "3.3"
   - "3.4"
+  - "3.5"
   - "nightly"
 install:
   - "pip install ."

README.rst

@@ -2,23 +2,40 @@ Vultr
 =====
 .. image:: https://travis-ci.org/spry-group/python-vultr.svg?branch=master
     :target: https://travis-ci.org/spry-group/python-vultr
-    
-Vultr provides a client library to the Vultr.com API.
+
+Vultr provides a client library to the `Vultr.com <http://www.vultr.com/?ref=6989379-3B>` API.
 
 **Usage**
 
+.. code:: python
 
     api_key = 'XXXXXXXXX'
-
     vultr = Vultr(api_key)
+    plans_json = vultr.plans.list()
+
+
+
+**Testing**
+
+    From the repo root directory
+    Performs generic, unauthenticated tests
+    
+.. code:: shell
+    
+    python -m unittest -v tests.test_vultr.UnauthenticatedTests
+
+
+Requires the environment variable VULTR_KEY to be set
+
+.. code:: shell
 
-    plans_json = vultr.plans_list()
+    python -m unittest -v tests.test_vultr.AuthenticatedTests
 
 
 **Support**
 
 
-Python Vultr is supported on a volunteer basis. 
+Python Vultr is supported on a volunteer basis.
 
 * `Open an Issue <https://github.com/spry-group/python-vultr/issues/new>`_
 
@@ -29,54 +46,57 @@ Python Vultr is supported on a volunteer basis.
 **API**
 
 
-* def __init__(self, api_key):
-* def snapshot_list(self):
-* def snapshot_destroy(self, snapshotid):
-* def snapshot_create(self, subid):
-* def iso_list(self):
-* def plans_list(self):
-* def regions_list(self):
-* def regions_availability(self, dcid):
-* def startupscript_list(self):
-* def startupscript_destroy(self, scriptid):
-* def startupscript_create(self, name, script):
-* def startupscript_update(self, scriptid, name, script):
-* def dns_list(self):
-* def dns_records(self, domain):
-* def dns_create_domain(self, domain, serverip):
-* def dns_delete_domain(self, domain):
-* def dns_delete_record(self, domain, recordid):
-* def dns_create_record(self, domain, name, type, data, ttl=None,
-* def sshkey_list(self):
-* def sshkey_destroy(self, sshkeyid):
-* def sshkey_create(self):
-* def sshkey_update(self, sshkeyid, name=None, ssh_key=None):
-* def backup_list(self):
-* def server_list(self, subid):
-* def server_bandwidth(self):
-* def server_reboot(self):
-* def server_halt(self):
-* def server_start(self):
-* def server_destroy(self):
-* def server_reinstall(self):
-* def server_restore_snapshot(self, subid, snapshotid):
-* def server_restore_backup(self, subid, backupid):
-* def server_create(self, dcid, vpsplanid, osid, ipxe_chain_url=None,
-* def server_list_ipv4(self, subid):
-* def server_reverse_set_ipv4(self):
-* def server_reverse_default_ipv4(self, subid, ip):
-* def server_list_ipv6(self):
-* def server_reverse_list_ipv6(self):
-* def server_reverse_set_ipv6(self, subid, ip, entry):
-* def server_reverse_delete_ipv6(self, subid, ip):
-* def server_label_set(self, subid, label):
-* def server_create_ipv4(self, subid, reboot):
-* def server_destroy_ipv4(self, subid, ip):
-* def server_os_change_list(self):
-* def server_os_change(self, subid, osid):
-* def server_upgrade_plan_list(self):
-* def server_upgrade_plan(self, subid, vpsplanid):
-* def app_list(self):
-* def account_info(self):
-* def os_list(self):
-* def request(self, path, params={}, method='GET'):
+* def account.info(self, params=None):
+* def app.list(self, params=None):
+* def backup.list(self, params=None):
+* def dns.create_domain(self, domain, ipaddr, params=None):
+* def dns.create_record(self, domain, name, _type, data, params=None):
+* def dns.delete_domain(self, domain, params=None):
+* def dns.delete_record(self, domain, recordid, params=None):
+* def dns.list(self, params=None):
+* def dns.records(self, domain, params=None):
+* def dns.update_record(self, domain, recordid, params=None):
+* def iso.list(self, params=None):
+* def iso.create_from_url(self, url, params=None)
+* def os.list(self, params=None):
+* def plans.list(self, params=None):
+* def regions.availability(self, dcid, params=None):
+* def regions.list(self, params=None):
+* def server.ipv4.create(self, subid, params=None):
+* def server.ipv4.destroy(self, subid, ipaddr, params=None):
+* def server.ipv4.list(self, subid, params=None):
+* def server.ipv4.reverse_default(self, subid, ipaddr, params=None):
+* def server.ipv4.reverse_set(self, subid, ipaddr, entry, params=None):
+* def server.ipv6.list_ipv6(self, subid, params=None):
+* def server.ipv6.reverse_delete_ipv6(self, subid, ipaddr, params=None):
+* def server.ipv6.reverse_list_ipv6(self, subid, params=None):
+* def server.ipv6.reverse_set_ipv6(self, subid, ipaddr, entry, params=None):
+* def server.bandwidth(self, subid, params=None):
+* def server.create(self, dcid, vpsplanid, osid, params=None):
+* def server.destroy(self, subid, params=None):
+* def server.get_user_data(self, subid, params=None):
+* def server.halt(self, subid, params=None):
+* def server.label_set(self, subid, label, params=None):
+* def server.list(self, subid=None, params=None):
+* def server.neighbors(self, subid, params=None):
+* def server.os_change(self, subid, osid, params=None):
+* def server.os_change_list(self, subid, params=None):
+* def server.reboot(self, subid, params=None):
+* def server.reinstall(self, subid, params=None):
+* def server.restore_backup(self, subid, backupid, params=None):
+* def server.restore_snapshot(self, subid, snapshotid, params=None):
+* def server.set_user_data(self, subid, userdata, params=None):
+* def server.start(self, subid, params=None):
+* def server.upgrade_plan(self, subid, vpsplanid, params=None):
+* def server.upgrade_plan_list(self, subid, params=None):
+* def snapshot.create(self, subid, params=None):
+* def snapshot.destroy(self, snapshotid, params=None):
+* def snapshot.list(self, params=None):
+* def sshkey.create(self, name, ssh_key, params=None):
+* def sshkey.destroy(self, sshkeyid, params=None):
+* def sshkey.list(self, params=None):
+* def sshkey.update(self, sshkeyid, params=None):
+* def startupscript.create(self, name, script, params=None):
+* def startupscript.destroy(self, scriptid, params=None):
+* def startupscript.list(self, params=None):
+* def startupscript.update(self, scriptid, params=None):

examples/basic_list.py

@@ -0,0 +1,81 @@
+#!/usr/bin/env python
+
+'''Basic app to list Vultr account & server information'''
+
+import logging
+from os import environ
+from json import dumps
+from vultr import Vultr, VultrError
+
+# Looks for an environment variable named "VULTR_KEY"
+API_KEY = environ.get('VULTR_KEY')
+logging.basicConfig(
+    level=logging.INFO,
+    format='%(asctime)s %(levelname)s [%(funcName)s():%(lineno)d] %(message)s'
+)
+logging.getLogger("requests").setLevel(logging.WARNING)
+
+
+def dump_info():
+    '''Shows various details about the account & servers'''
+    vultr = Vultr(API_KEY)
+
+    try:
+        logging.info('Listing account info:\n%s', dumps(
+            vultr.account.info(), indent=2
+        ))
+
+        logging.info('Listing apps:\n%s', dumps(
+            vultr.app.list(), indent=2
+        ))
+
+        logging.info('Listing backups:\n%s', dumps(
+            vultr.backup.list(), indent=2
+        ))
+
+        logging.info('Listing DNS:\n%s', dumps(
+            vultr.dns.list(), indent=2
+        ))
+
+        logging.info('Listing ISOs:\n%s', dumps(
+            vultr.iso.list(), indent=2
+        ))
+
+        logging.info('Listing OSs:\n%s', dumps(
+            vultr.os.list(), indent=2
+        ))
+
+        logging.info('Listing plans:\n%s', dumps(
+            vultr.plans.list(), indent=2
+        ))
+
+        logging.info('Listing regions:\n%s', dumps(
+            vultr.regions.list(), indent=2
+        ))
+
+        logging.info('Listing servers:\n%s', dumps(
+            vultr.server.list(), indent=2
+        ))
+
+        logging.info('Listing snapshots:\n%s', dumps(
+            vultr.snapshot.list(), indent=2
+        ))
+
+        logging.info('Listing SSH keys:\n%s', dumps(
+            vultr.sshkey.list(), indent=2
+        ))
+
+        logging.info('Listing startup scripts:\n%s', dumps(
+            vultr.startupscript.list(), indent=2
+        ))
+    except VultrError as ex:
+        logging.error('VultrError: %s', ex)
+
+
+def main():
+    '''Entry point'''
+    logging.info('Vultr API Client Python Library')
+    logging.info('URL: https://www.vultr.com/api/')
+    dump_info()
+
+main()

setup.py

@@ -1,5 +1,5 @@
-import sys
-from setuptools import setup, find_packages
+'''Module setup'''
+from setuptools import setup
 
 '''
 packaging modeled after
@@ -8,13 +8,14 @@
 
 
 def read(filename):
+    '''Read content from file'''
     return open(filename).read()
 
 setup(
     name='vultr',
-    version='0.1.2',
+    version='1.0rc1',
     install_requires=[
-      "requests"
+        "requests"
     ],
     description='Vultr.com API Client',
     long_description=(read('README.rst')),
@@ -32,6 +33,8 @@ def read(filename):
         'Programming Language :: Python :: 2.7',
         'Programming Language :: Python :: 3',
         'Programming Language :: Python :: 3.3',
+        'Programming Language :: Python :: 3.4',
+        'Programming Language :: Python :: 3.5',
         'Topic :: Software Development :: Libraries :: Python Modules'
     ],
     license=read('LICENSE'),

tests/__init__.py

@@ -0,0 +1,2 @@
+from .test_vultr import UnauthenticatedTests
+from .test_vultr import AuthenticatedTests