update readme and setup.py

master
George Hotz 2017-06-20 15:40:34 -07:00
parent dd75b6170e
commit ac565fd666
2 changed files with 41 additions and 37 deletions

View File

@ -16,6 +16,11 @@ It is 2nd gen hardware, reusing code and parts from the [NEO](https://github.com
Usage
------
To install the library:
```
# pip install pandacan
```
See [panda.py](https://github.com/commaai/panda/blob/master/lib/panda.py) for how to interact with the panda.
For example, to receive CAN messages:

View File

@ -18,47 +18,46 @@ from setuptools import setup, Extension
here = os.path.abspath(os.path.dirname(__file__))
def read(*parts):
"""Taken from pypa pip setup.py:
intentionally *not* adding an encoding option to open, See:
https://github.com/pypa/virtualenv/issues/201#issuecomment-3145690
"""
return codecs.open(os.path.join(here, *parts), 'r').read()
"""Taken from pypa pip setup.py:
intentionally *not* adding an encoding option to open, See:
https://github.com/pypa/virtualenv/issues/201#issuecomment-3145690
"""
return codecs.open(os.path.join(here, *parts), 'r').read()
def find_version(*file_paths):
version_file = read(*file_paths)
version_match = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]",
version_file, re.M)
if version_match:
return version_match.group(1)
raise RuntimeError("Unable to find version string.")
version_file = read(*file_paths)
version_match = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]",
version_file, re.M)
if version_match:
return version_match.group(1)
raise RuntimeError("Unable to find version string.")
setup(
name='pandacan',
version=find_version("panda", "__init__.py"),
url='https://github.com/commaai/panda',
author='comma.ai',
author_email='',
packages=[
'panda',
],
platforms='any',
license='MIT',
install_requires=[
'libusb1 >= 1.6.4',
'hexdump >= 3.3',
'pycrypto >= 2.6.1',
'tqdm >= 4.14.0',
],
ext_modules = [],
description="Code powering the comma.ai panda",
long_description=open(os.path.join(os.path.dirname(__file__),
'README.md')).read(),
classifiers=[
'Development Status :: 2 - Pre-Alpha',
"Natural Language :: English",
"Programming Language :: Python :: 2",
"Programming Language :: Python :: 3",
"Topic :: System :: Hardware",
name='pandacan',
version=find_version("panda", "__init__.py"),
url='https://github.com/commaai/panda',
author='comma.ai',
author_email='',
packages=[
'panda',
],
platforms='any',
license='MIT',
install_requires=[
'libusb1 >= 1.6.4',
'hexdump >= 3.3',
'pycrypto >= 2.6.1',
'tqdm >= 4.14.0',
],
ext_modules = [],
description="Code powering the comma.ai panda",
long_description='See https://github.com/commaai/panda',
classifiers=[
'Development Status :: 2 - Pre-Alpha',
"Natural Language :: English",
"Programming Language :: Python :: 2",
"Programming Language :: Python :: 3",
"Topic :: System :: Hardware",
],
)