V1.1

Author: ZACHSTRIVES

INFO.rst

@@ -0,0 +1,94 @@
+PyNeuro
+=======
+
+PyNeuro is designed to connect NeuroSky's MindWave EEG device to Python
+and provide Callback functionality to provide data to your application
+in real time. The library is tested with Mindwave Mobie2 Headset, and
+runs stably.
+
+Installation
+------------
+
+Run the following command: ``pip install PyNeuro``
+
+Usage
+-----
+
+1. Importing the module: ``from NeuroPy import NeuroPy``
+2. Initializing: ``pn = PyNeuro()``
+3. After initializing, if required the callbacks can be set
+4. Then call ``pn.connect()`` method, it will connect with TCP Socket
+   server.
+5. Then call ``pn.start()`` method, it will be start fetching data.
+6. To stop call ``pn.close()``
+
+Obtaining Data from Device
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+-  **Obtaining value:** ``attention = pn.attention`` #to get value of
+   attention\_ >\ **Other Variable** attention, meditation,
+   blinkStrength, will be added more soon.
+
+-  **Setting callback:** A call back can be associated with all the
+   above variables so that a function is called when the variable is
+   updated. Syntax:
+
+   ::
+
+       pn.set_attention_callback(callback_function1)
+       pn.set_meditation_callback(callback_function2)
+       pn.set_blinkStrength_callback(callback_function3)
+
+       You can add any number of callback functions to a variable..
+
+Sample Program 1 (Access via callback)
+--------------------------------------
+
+.. code:: python
+
+    from PyNeuro import PyNeuro
+    from time import sleep
+
+    pn = PyNeuro() 
+
+    def attention_callback(attention_value):
+        """this function will be called everytime NeuroPy has a new value for attention"""
+        print ("Value of attention is: ", attention_value)
+        return None
+
+    pn.set_attention_callback("attention", attention_callback)
+    pn.connect()
+    pn.start()
+
+    try:
+        while True:
+            sleep(0.2)
+    finally:
+        neuropy.close()
+
+Sample Program 2 (Access via object)
+------------------------------------
+
+.. code:: python
+
+    from PyNeuro import PyNeuro
+    from time import sleep
+
+    pn = PyNeuro() 
+    pn.start()
+
+    while True:
+        if pn.meditation > 70: # Access data through object
+            pn.close() 
+        sleep(0.2) 
+
+Python Compatibility
+--------------------
+
+-  `Python <http://www.python.com>`__ -v3.\*
+
+Reference
+~~~~~~~~~
+
+`lihas/NeuroPy <https://github.com/lihas/NeuroPy>`__ - A library based
+on native Bluetooth serial connection

setup.py

@@ -1,10 +1,21 @@
-from distutils.core import setup
+from setuptools import setup
+
+
 
 setup(name="PyNeuro",
-      version="1.0",
+      version="1.1",
       description="Library for connect with Neurosky's Mindwave EEG headset via TCP Socket",
       author="Zach Wang",
       author_email="[email protected]",
+      long_description=open('INFO.rst', 'r').read(),
+      license="MIT",
+      classifiers=[
+        "License :: OSI Approved :: MIT License",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.7",
+      ],
       url="https://github.com/ZACHSTRIVES/PyNeuro",
-      packages=['PyNeuro']
+      packages=['PyNeuro'],
+
+
       )