Updated project metadata

CHANGES.txt

@@ -1 +1,14 @@
 v1.5.0, 6/27/10 -- Initial Packaging. Fully restructured into a unified API with tests.
+v1.7.0  6/29/10 -- Now supports both Series 1 and Series 2 modules 
+                   (the API turned out to be the same). Additionally:
+                   * API frame logic was split into its own class, APIFrame
+                   * XBee renamed to XBeeBase
+                   * XBee1 renamed to XBee
+                   * Tests updated to reflect changes; API frame tests
+                     moved to test_frame.py, now test APIFrame instead of
+                     XBee base class
+                   * Test files renamed appropriately
+                   * PyLint score improved
+                   * Various docstring updates
+                   * Updated example code to reflect changes
+

README.txt

@@ -9,12 +9,12 @@ look like this::
 
     #! /usr/bin/python
 
-    # Import and init a XBee Series 1 device
-    from xbee import XBee1
+    # Import and init an XBee device
+    from xbee import XBee
     import serial
 
     ser = serial.Serial('/dev/ttyUSB0', 9600)
-    xbee = XBee1(ser)
+    xbee = XBee(ser)
 
     # Set remote DIO pin 2 to low (mode 4)
     xbee.remote_at(
@@ -30,11 +30,11 @@ look like this::
 Usage
 ============
 
-Series 1
----------
+Series 1, Series 2
+------------------
 
-To use this library with an XBee Series 1 device, import the class
-XBee1 and call its constructor with a serial port object.
+To use this library with an XBee device, import the class
+XBee and call its constructor with a serial port object.
 
 In order to send commands via the API, call a method with the same
 name as the command which you would like to send with words separated
@@ -44,13 +44,29 @@ remote_at().
 The arguments to be given to each method depend upon the command to be 
 sent. For more information concerning the names of the arguments which
 are expected and the proper data types for each argument, consult the
-API manual for the XBee Series 1 device, or consult the source code.
+API manual for your XBee device, or consult the source code.
+
+Caveats
+---------
+
+Escaped API operation has not been implemented at this time.
+
+Dependencies
+============
+
+PySerial
+
+Additional Dependencies (for running tests):
+--------------------------------------------
+
+Nose
 
-Series 2
------------
+XBee Firmware
+-------------
 
-At this time, Series 2 API commands have not yet been translated from 
-the API documentation into the library.
+Please ensure that your XBee device is programmed with the latest firmware
+provided by Digi. Using old firmware revisions is not supported and
+may result in unspecified behavior.
 
 Contributors
 ==================

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name='XBee',
-    version='1.5.0',
+    version='1.7.0',
     author='Paul Malmsten',
     author_email='[email protected]',
     packages=['xbee', 'xbee.tests'],
@@ -11,4 +11,6 @@
     license='LICENSE.txt',
     description='Python tools for working with XBee radios',
     long_description=open('README.txt').read(),
+    requires=['serial'],
+    provides=['xbee','xbee.tests']
 )