Update version numbers (#78)

Version number updates
ukBaz · Oct 7, 2016 · f124490 · f124490
1 parent d1d7a1d
commit f124490
Show file tree

Hide file tree

Showing 5 changed files with 46 additions and 10 deletions.
diff --git a/README.rst b/README.rst
@@ -18,7 +18,7 @@ python-bluezero
    :alt: Issue Count
 
 
-A simple Python interface to Bluez stack
+A simple Python interface to BlueZ stack
 
 Name and aim
 ============
@@ -71,14 +71,14 @@ eddystone-url-beacon.py
 ***********************
 Simple Eddystone URL beacon. Can be read with any Physical Web application
 
-fatbeacon.py
-************
-Experiment with Eddystone FatBeacon. Contains service for beacon to connect to that sends html page.
-
 Scanner
 -------
 No example currently.
 
 GATT Server (Peripheral role)
 -----------------------------
-No working example
+
+fatbeacon.py
+************
+Experiment with Eddystone FatBeacon. Contains service for beacon to connect to that sends html page.
+
diff --git a/bluezero/advertisement.py b/bluezero/advertisement.py
@@ -97,6 +97,7 @@ def Release(self):
 
     @property
     def service_UUIDs(self):
+        """List of UUIDs that represent available services."""
         return self.Get(constants.LE_ADVERTISEMENT_IFACE,
                         'ServiceUUIDs')
 
@@ -107,13 +108,16 @@ def service_UUIDs(self, UUID):
                  UUID)
 
     def manufacturer_data(self):
+        """Manufacturer Data to be broadcast (Currently not supported)"""
         pass
 
     def solicit_UUIDs(self):
+        """Manufacturer Data to be broadcast (Currently not supported)"""
         pass
 
     @property
     def service_data(self):
+        """Service Data to be broadcast"""
         return self.Get(constants.LE_ADVERTISEMENT_IFACE,
                         'ServiceData')
 
@@ -126,6 +130,7 @@ def service_data(self, data):
 
     @property
     def include_tx_power(self):
+        """Include TX power in advert (Different from beacon packet)"""
         return self.Get(constants.LE_ADVERTISEMENT_IFACE,
                         'IncludeTxPower')
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -55,9 +55,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = u'0'
+version = u'0.0.2'
 # The full version, including alpha/beta/rc tags.
-release = u'0.1'
+release = u'0.0.2'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/docs/developer_notes.rst b/docs/developer_notes.rst
@@ -0,0 +1,31 @@
+====================
+Notes For Developers
+====================
+
+
+
+Build pypi package
+------------------
+
+Update version information in setup.py.
+
+To upload to pypi:
+
+.. code-block:: none
+
+    python3 setup.py sdist bdist_wheel upload -r pypi
+
+
+Build Documentation
+-------------------
+
+Update version information in docs/conf.py:
+
+.. code-block:: none
+
+    cd docs
+    make clean
+    make html
+    cd ..
+    python3 setup.py upload_docs --upload-dir docs/_build/html
+
diff --git a/setup.py b/setup.py
@@ -23,7 +23,7 @@
     # Versions should comply with PEP440.  For a discussion on single-sourcing
     # the version across setup.py and the project code, see
     # https://packaging.python.org/en/latest/single_source_version.html
-    version='0.0.1',
+    version='0.0.2',
 
     description='Python library for Bluetooth Low Energy (BLE) on Linux',
     long_description=long_description,
@@ -37,7 +37,7 @@
     maintainer='Barry Byford',
     maintainer_email='[email protected]',
     # Choose your license
-    license='BSD',
+    license='MIT',
 
     # See https://pypi.python.org/pypi?%3Aaction=list_classifiers
     classifiers=[