Big restructuring, creation of Context object with attributes and methods

Author: MelindaShore

README.md

@@ -10,8 +10,8 @@ Built and tested against Python 2.7.  You will need to install
 the Python headers and libraries - this is usually a package
 called "python-dev"
 
-Currently building against the getdns "develop" branch (to be released
-as 0.1.1).  getdns external dependencies include:
+Currently building against the getdns 0.1.3 release.
+getdns external dependencies include:
 
 * [libldns from NLnet Labs](https://www.nlnetlabs.nl/projects/ldns/) version 1.6.11 or later (ldns requires ope
 nssl headers and libraries)
@@ -21,6 +21,9 @@ nssl headers and libraries)
 * [libevent](http://libevent.org) version 2.0.21 stable, sometimes called libevent2 (only needed if you plan to
  use it for asynchronous handling)
 
+Note that getdns **MUST** be built with the --with-libevent flag to
+configure.
+
 Building
 ========
 To build, 
@@ -51,19 +54,24 @@ Documentation
 
 Documentation is formatted using the [sphinx](http://sphinx-doc.org/)
 documentation system.  The html-formatted output is under the pygetdns
-source tree in doc/_build/html.
+source tree in doc/_build/html.  It is also available online at [readthedogs.org]
+(https://getdns.readthedocs.org/)
+
+Changes from the earlier release
+================================
 
-Known issues
-============
+We've introduced a Context object with attributes and methods, with
+queries being Context methods.  Attributes can be assigned and read
+directly without using the getdns setters and getters.  For example,
 
-There are several issues in this alpha release which we expect to be resolved
-prior to the TNW hack battle.  These include:
+```python
+import getdns.context
+my_context = getdns.Context()
+my_context.timeout = 1000
+print my_context.timeout
+```
 
-* the asynchronous code is not actually asynchronous; it invokes the
-  callback but the calling function blocks until the callback returns
-* getdns exception error strings are not "bubbling up" to the user
-  from deeply nested functions.  You may see an exception thrown with
-  a warning that the error string is not set as a result
+Please see the documentation for details on attributes and methods.
 
 Examples
 ========

examples/example_address.py

@@ -7,9 +7,9 @@ def main():
         print "Usage: {0} hostname".format(sys.argv[0])
         sys.exit(1)
 
-    ctx = getdns.context_create()
+    ctx = getdns.Context()
     extensions = { "return_both_v4_and_v6" : getdns.GETDNS_EXTENSION_TRUE }
-    results = getdns.address(ctx, name=sys.argv[1], extensions=extensions)
+    results = ctx.address(name=sys.argv[1], extensions=extensions)
     if results["status"] == getdns.GETDNS_RESPSTATUS_GOOD:
         sys.stdout.write("Addresses: ")
 

examples/example_dnssec.py

@@ -21,10 +21,10 @@ def main():
         print "Usage: {0} hostname".format(sys.argv[0])
         sys.exit(1)
 
-    ctx = getdns.context_create()
+    ctx = getdns.Context()
     extensions = { "return_both_v4_and_v6" : getdns.GETDNS_EXTENSION_TRUE,
                    "dnssec_return_status" : getdns.GETDNS_EXTENSION_TRUE }
-    results = getdns.address(ctx, name=sys.argv[1], extensions=extensions)
+    results = ctx.address(name=sys.argv[1], extensions=extensions)
     if results["status"] == getdns.GETDNS_RESPSTATUS_GOOD:
         sys.stdout.write("Addresses: ")
         for addr in results["just_address_answers"]:

examples/example_hostname.py

@@ -9,7 +9,7 @@ def main():
         print "Usage: {0} ipaddress".format(sys.argv[0])
         sys.exit(1)
 
-    ctx = getdns.context_create()
+    ctx = getdns.Context()
     addr["address_data"] = sys.argv[1]
     if string.find(sys.argv[1], ":") != -1:
         addr["address_type"] = "IPv6"
@@ -18,7 +18,7 @@ def main():
     else:
         print "{0}: undiscernable address type".format(sys.argv[1])
         sys.exit(1)
-    results = getdns.hostname(ctx, address=addr)
+    results = ctx.hostname(address=addr)
     if results["status"] == getdns.GETDNS_RESPSTATUS_GOOD:
         print "Hostnames:"
         for responses in results["replies_tree"]: