Merge pull request #8 from Overdrivr/packaging

Packaging

Author: Overdrivr

MANIFEST.in

@@ -0,0 +1,3 @@
+include *.md
+include *.png
+include *.svg

README.md

@@ -15,7 +15,7 @@ This command line interface is for you if:
 If you recognize yourself with any of the above points, this application is for you.
 
 ## Overview
-pytelemetry-cli (this repo) is a **command line interface**. It provides a set of commands to connect to a device, read, plot and write data on it.
+pytelemetry-cli is a **command line interface**. It provides a set of commands to connect to a device, read, plot and write data on it.
 pytelemetry-cli relies on [`pytelemetry`](https://github.com/Overdrivr/pytelemetry)
 [![PyPI version](https://badge.fury.io/py/pytelemetry.svg)](https://badge.fury.io/py/pytelemetry)
 to implement the specific communication protocol.
@@ -77,10 +77,10 @@ The command line interface can be started like this
 python -m pytelemetrycli.cli
 ```
 
-#### help [command]
+### help [command]
 Without arguments, you get a list of all available commands. Otherwise the full `command` documentation.
 
-#### ls
+### ls
 ```bash
 Without options, prints a list of all received topics.
 With the --serial flag, prints a list of all available COM ports
@@ -91,7 +91,7 @@ Options:
 -s, --serial     Use this flag to print a list of all available serial ports
 ```
 
-#### serial
+### serial
 ```bash
 Connects pytelemetry to the serial port.
 
@@ -101,7 +101,7 @@ Options:
 -b X, --bauds X        Connection speed in bauds  [default: 9600]
 ```
 
-#### print
+### print
 ```bash
 Prints X last received samples from <topic>.
 
@@ -111,28 +111,28 @@ Options:
 -a X, --amount X        Amount of samples to display [default: 1]
 ```
 
-#### pub
+### pub
 ```bash
 Publishes a (value | string) on <topic>.
 
 Usage: pub <topic> <value> (--u8 | --u16 | --u32 | --i8 | --i16 | --i32 | --f32 | --s)
 ```
 
-#### plot
+### plot
 ```bash
 Plots <topic> in a graph window.
 
 Usage: plot <topic>
 ```
 
-#### disconnect
+### disconnect
 ```bash
 Disconnects from any open connection.
 
 Usage: disconnect
 ```
 
-#### quit
+### quit
 ```bash
 Exits the terminal application.
 

pytelemetrycli/cli.py

@@ -7,9 +7,6 @@
 import topics
 import runner
 from serial.tools import list_ports
-import numpy as np
-from collections import deque
-from numpy.random import ranf
 import ui.superplot as ui
 
 def docopt_cmd(func):
@@ -45,7 +42,7 @@ def __init__(self):
 
         # pytelemetry setup
         self.transport = transports.SerialTransport()
-        self.telemetry = tm.pytelemetry(self.transport)
+        self.telemetry = tm.Pytelemetry(self.transport)
         self.topics = topics.Topics()
         self.runner = runner.Runner(self.transport,self.telemetry)
         self.telemetry.subscribe(None,self.topics.process)

setup.cfg

@@ -0,0 +1,5 @@
+[bdist_wheel]
+# This flag says that the code is written to work on both Python 2 and Python
+# 3. If at all possible, it is good practice to do this. If you cannot, you
+# will need to generate wheels for each Python version that you support.
+universal=0

setup.py

@@ -0,0 +1,81 @@
+from setuptools import setup, find_packages, Extension
+from codecs import open
+from os import path
+from setuptools.dist import Distribution
+import pypandoc
+
+pypandoc.convert('README.md', 'rst', outputfile="README.rst")
+
+here = path.abspath(path.dirname(__file__))
+
+# Get the long description from the README file
+with open(path.join(here, 'README.rst'), encoding='utf-8') as f:
+    long_description = f.read()
+
+setup(
+    name='pytelemetrycli',
+
+    version='1.0.0',
+
+    description='command-line interface for superior communication with any embedded device.',
+    long_description=long_description,
+
+    url='https://github.com/Overdrivr/pytelemetrycli',
+
+    author='Rémi Bèges',
+    author_email='remi.beges@gmail.com',
+
+    license='MIT',
+
+    # See https://pypi.python.org/pypi?%3Aaction=list_classifiers
+    classifiers=[
+        'Development Status :: 4 - Beta',
+
+        # Indicate who your project is intended for
+        'Intended Audience :: Developers',
+        'Intended Audience :: End Users/Desktop',
+        'Intended Audience :: Telecommunications Industry',
+        'Topic :: Communications',
+        'Topic :: Scientific/Engineering :: Human Machine Interfaces',
+        'Topic :: Software Development :: Embedded Systems',
+        'Topic :: Software Development :: Libraries :: Python Modules',
+
+        # Pick your license as you wish (should match "license" above)
+        'License :: OSI Approved :: MIT License',
+
+        # Specify the Python versions you support here. In particular, ensure
+        # that you indicate whether you support Python 2, Python 3 or both.
+        'Programming Language :: Python :: 3.4',
+        'Programming Language :: Python :: 3.5',
+    ],
+
+    keywords='cli plot debug lightweight communication protocol embedded telemetry remote program control',
+
+    # You can just specify the packages manually here if your project is
+    # simple. Or you can use find_packages().
+    packages=find_packages(),
+
+    # List run-time dependencies here.  These will be installed by pip when
+    # your project is installed. For an analysis of "install_requires" vs pip's
+    # requirements files see:
+    # https://packaging.python.org/en/latest/requirements.html
+    install_requires=['pytelemetry','pyserial','docopt','pyqtgraph','numpy'],
+
+    # List additional groups of dependencies here (e.g. development
+    # dependencies). You can install these using the following syntax,
+    # for example:
+    # $ pip install -e .[dev,test]
+    extras_require={
+        'dev': ['check-manifest'],
+        'test': ['pytest','pytest-cov'],
+    },
+
+    # To provide executable scripts, use entry points in preference to the
+    # "scripts" keyword. Entry points provide cross-platform support and allow
+    # pip to create the appropriate form of executable for the target platform.
+    entry_points={
+        'console_scripts': [
+            'tlm = pytelemetrycli.cli:main',
+        ],
+    },
+)