upd:

- fix package version
- add/update docs

Author: anton-ptashnik

godice/__init__.py

@@ -1,7 +1,7 @@
 """
 GoDice Python API
 """
-__version__ = "0.0.1"
+__version__ = "0.1.0"
 
 from .factory import (
     create,

godice/demo.py

@@ -1,3 +1,6 @@
+"""
+Demo script that connects to the closest dice, sets LED color and listens for position updates
+"""
 import asyncio
 import bleak
 import godice

godice/dice.py

@@ -1,3 +1,6 @@
+"""
+Dice API
+"""
 import asyncio
 import struct
 import enum
@@ -94,7 +97,7 @@ async def pulse_led(self, pulse_count, on_time_ms, off_time_ms, rgb_tuple):
 
     async def get_color(self):
         """
-        Read dice color ()
+        Read dice color
         """
         self._color = self._color or await self._fetch_color()
         return self._color

godice/factory.py

@@ -33,7 +33,7 @@ class DiceType(enum.Enum):
 
 def create(ble_client: bleak.BleakClient, dice_type: DiceType):
     """
-    Creates an object representing the specified dice type
+    Creates Dice API object representing the specified type of a dice
     """
     _xyzinterpret_fn = xyz_interpret_map[dice_type]
     return dice.Dice(ble_client, _xyzinterpret_fn)

godice/xyzinterpret.py

@@ -1,5 +1,5 @@
 """
-Includes position vectors and functions to translate a coord to a number based on a dice type
+Tools needed to translate coords sent by a dice to a resulting number based on a dice type
 """
 
 import math
@@ -192,10 +192,10 @@ def _get_closest_vector(die_table, coord):
     :return: the value of the closest vector to the die's vector
     """
 
-    def _key2distance(key):
+    def _distance_as_key(key):
         vec = die_table[key]
         return math.dist(coord, vec)
-    return min(die_table.keys(), key=_key2distance)
+    return min(die_table.keys(), key=_distance_as_key)
 
 
 def get_rolled_number_d6(xyz):