Add readme and setup

ladniac · ladniac · commit 7c57332b2c44 · 2017-09-01T10:09:24.000+02:00
diff --git a/bits_coder/coder.py b/bits_coder/coder.py
@@ -150,3 +150,4 @@ def decode(self, pld):
                 (2 ** field.nbits - 1)
             )
             field.decode(value)
+        self._create_fields_map()
diff --git a/readme.md b/readme.md
@@ -0,0 +1,53 @@
+# BitsCoder
+
+Tool for encoding/decoding binary messages
+
+## Installation
+
+Clone repository:
+
+    $ git clone https://github.com/ladniac/bits_coder.git
+    
+Install package in your virtualenv:
+
+    $ pip setup.py install
+    
+    
+## Basic usage
+
+### Encoding messages
+
+Let's say we want to endode a following message:
+
+    data = {
+        'temperature': 21,
+		 'is_nice': True,
+		 'lat': 78.234,
+		 'lon': -33.111
+    }
+    
+And we want to use a following format:
+[5b temperature][1b is_nice][18b lat][18b lon][5b empty]
+
+    >>> from bits_coder.fields import Int, Bool, Float
+    >>> from bits_coder.coder import BitsCoder
+    >>> coder = BitsCoder(
+    	[
+    		Int(6, name='temperature', value=data['temperature']),
+    		Bool(1, name='is_nice', value=data['is_nice']),
+    		Float(18, frac=3, name='lat', value=data['lat']),
+    		Float(18, frac=3, name='lon',  value=data['lon'])
+    	]
+    )
+
+
+    >>> encoded_msg = coder.encode()
+    >>> print(encoded_msg.hex())
+    5698cd6fd520
+
+You can use the same BitsCoder instance to decode messages (fields without names will be named as ___n):
+
+    >>> coder.decode('FA123155A100')
+    >>> print(coder.map)
+    {'temperature': -2, 'is_nice': True, 'lat': 9.314, 'lon': -86.776, '___1': 0}
+
diff --git a/setup.py b/setup.py
@@ -0,0 +1,16 @@
+from setuptools import setup, find_packages
+
+
+setup(
+    name="bits_coder",
+    version="0.1.0",
+    packages=find_packages(),
+    install_requires=[],
+    author="Szymon &#321;adniak",
+    author_email="ladniac@gmail.com",
+    description="Tool for encoding/decoding binary messages",
+    license="GPL",
+    keywords=["binary decoder encoder"],
+    url="https://github.com/ladniac/bits_coder",
+    python_requires='>=3.6'
+)

Original file line number	Diff line number	Diff line change
`@@ -150,3 +150,4 @@ def decode(self, pld):`
`150`	`150`	`(2 ** field.nbits - 1)`
`151`	`151`	`)`
`152`	`152`	`field.decode(value)`
	`153`	`+ self._create_fields_map()`