diff --git a/README.rst b/README.rst index 8c2f0ebb..2b1e179c 100644 --- a/README.rst +++ b/README.rst @@ -19,7 +19,7 @@ Dependencies Usage ----- -After installing the library, simply import pyobd, and create a new OBD connection object. By default, python-OBD will scan for Bluetooth and USB serial ports (in that order), and will pick the first connection it finds. The port can also be specified manually by passing a connection string to the OBD constructor. You can also use the scanSerial helper retrieve a list of connected ports:: +After installing the library, simply import 'obd', and create a new OBD connection object. By default, python-OBD will scan for Bluetooth and USB serial ports (in that order), and will pick the first connection it finds. The port can also be specified manually by passing a connection string to the OBD constructor. You can also use the scanSerial helper retrieve a list of connected ports:: import obd diff --git a/setup.py b/setup.py new file mode 100644 index 00000000..9f4751bd --- /dev/null +++ b/setup.py @@ -0,0 +1,28 @@ +#!/bin/env python +# -*- coding: utf8 -*- + +from setuptools import setup, find_packages + +setup( + name="obd", + version="0.1.0", + description=("Serial module for handling live sensor data from a vehicle's OBD-II port"), + classifiers=[ + "Operating System :: POSIX :: Linux", + "License :: OSI Approved :: GNU General Public License v2 (GPLv2)", + "Topic :: System :: Monitoring", + "Programming Language :: Python :: 2", + "Development Status :: 3 - Alpha", + "Topic :: System :: Logging", + "Intended Audience :: Developers", + ], + keywords="obd obd-II obd-ii obd2 car serial vehicle diagnostic", + author="Brendan Whitfield", + author_email="brendanw@windworksdesign.com", + url="http://github.com/brendanwhitfield/python-OBD", + license="GNU GPLv2", + packages=find_packages(), + include_package_data=True, + zip_safe=False, + install_requires=["pyserial"], +) \ No newline at end of file