Commit aad2315d authored by Javier Ortega's avatar Javier Ortega
Browse files

update readme, setup.py

parent 008f4ec0
*.pyc
build
dist
*.egg-info
......@@ -7,6 +7,7 @@
[RS485]: http://git.whitewallenergy.com/whitewall/ivy_gw/blob/master/docs/ivy_gw/rs485/README.md
[GPIO]: http://git.whitewallenergy.com/whitewall/ivy_gw/blob/master/docs/ivy_gw/gpio/README.md
[Modbus]: http://git.whitewallenergy.com/whitewall/ivy_gw/blob/master/docs/ivy_gw/modbus/README.md
[examples]: http://git.whitewallenergy.com/whitewall/ivy_gw/blob/master/examples
[LICENSE]: LICENSE.md
[Español]: CONTRIBUTING_ES.md
[English]: CONTRIBUTING.md
......@@ -17,20 +18,36 @@ Developed by [Whitewall Energy], Ivy is a low power consumption IoT Gateway that
Documentation for developing can be found in the [wiki].
> **Índice**
* [Usage](#usage)
* [API reference](#api-reference)
* [License](#license)
* [Package Guidelines](#package-guidelines)
* **Index**
* [Usage](#usage)
* [API reference](#api-reference)
* [License](#license)
* [Package Guidelines](#package-guidelines)
# Usage
To use this project, you must first download it to your computer:
### Installation
```
git clone http://git.whitewallenergy.com/whitewall/ivy_gw.git
cd ivy_gw
python setup.py install
```
### Example modbus
```
# import modbus
from ivy_gw.modbus import modbus
# create instance
m = modbus.Modbus()
# use
print m.raw('\x01\x02\x03')
```
See all the [examples].
# API Reference
You can browse the generated API documentation directly on Git.
......@@ -45,6 +62,6 @@ See [LICENSE] file.
# Package Guidelines
Puede leer esta guía de contribución en [Español](CONTRIBUTING_ES.md).
Puede leer esta guía de contribución en [Español].
You can read this guide of contributions in [English](CONTRIBUTING.md).
You can read this guide of contributions in [English].
Developed by `Whitewall Energy <http://whitewallenergy.com>`__, Ivy is a
low power consumption IoT Gateway that allows the integration of `Modbus
networks <https://en.wikipedia.org/wiki/Modbus>`__ and Wifi nodes in
industrial environments for access from any browser device.
Documentation for developing can be found in the
`wiki <http://git.whitewallenergy.com/whitewall/ivy_gw/wikis/home>`__.
- **Index**
- `Usage <#usage>`__
- `API reference <#api-reference>`__
- `License <#license>`__
- `Package Guidelines <#package-guidelines>`__
Usage
=====
To use this project, you must first download it to your computer:
Installation
~~~~~~~~~~~~
::
git clone http://git.whitewallenergy.com/whitewall/ivy_gw.git
cd ivy_gw
python setup.py install
Example modbus
~~~~~~~~~~~~~~
::
# import modbus
from ivy_gw.modbus import modbus
# create instance
m = modbus.Modbus()
# use
print m.raw('\x01\x02\x03')
See all the
`examples <http://git.whitewallenergy.com/whitewall/ivy_gw/blob/master/examples>`__.
API Reference
=============
You can browse the generated API documentation directly on Git.
- `RS485 <http://git.whitewallenergy.com/whitewall/ivy_gw/blob/master/docs/ivy_gw/rs485/README.md>`__
- `GPIO <http://git.whitewallenergy.com/whitewall/ivy_gw/blob/master/docs/ivy_gw/gpio/README.md>`__
- `Modbus <http://git.whitewallenergy.com/whitewall/ivy_gw/blob/master/docs/ivy_gw/modbus/README.md>`__
License
=======
See `LICENSE <LICENSE.md>`__ file.
Package Guidelines
==================
Puede leer esta guía de contribución en
`Español <CONTRIBUTING_ES.md>`__.
You can read this guide of contributions in
`English <CONTRIBUTING.md>`__.
[metadata]
license_file = LICENSE.md
description-file = README.md
from setuptools import setup, find_packages
from codecs import open
from os import path
# Generate README.rst
# pandoc --from=markdown --to=rst --output=README.rst README.md
here = path.abspath(path.dirname(__file__))
NAME = 'ivy_gw'
VERSION = '1.0.0'
GIT = 'http://git.whitewallenergy.com/whitewall/ivy_gw'
WIKI = 'http://git.whitewallenergy.com/whitewall/ivy_gw/wikis/home'
ISSUES = 'http://git.whitewallenergy.com/whitewall/ivy_gw/issues/new'
AUTHOR = 'Javi Ortega'
EMAIL = 'javier.ortega@whitewallenergy.com'
KEYWORDS = 'whitewallenergy python IoT gpio rs485 modbus ivy'
DESCRIPTION = 'Package to handler gpio, rs485, modbus in Ivy IoT Gateway (Whitewall Energy)'
LONG_DESCRIPTION = ''
with open(path.join(here, 'README.rst'), encoding='utf-8') as f:
LONG_DESCRIPTION = f.read()
GPIO_LIB_PATH = 'ivy_gw/gpio/lib/'
# specify requirements of ivy_gw
# gpio: os, platform, ctypes
# modbus: platform, sys, os, serial, struct, time
# rs485: os, sys
REQUIREMENTS = [
# 'ctypes',
# 'os',
# 'platform',
'pyserial',
# 'struct',
# 'sys',
# 'time'
]
# https://pypi.org/classifiers/
CLASSIFIERS = [
'Development Status :: 5 - Production/Stable',
'Intended Audience :: Developers',
'Intended Audience :: Telecommunications Industry',
'Topic :: Software Development :: Build Tools'
'Topic :: Software Development :: Libraries :: Python Modules',
'License :: OSI Approved :: MIT License',
'Programming Language :: Python',
'Programming Language :: Python :: 2',
'Programming Language :: Python :: 2.6',
'Programming Language :: Python :: 2.7',
]
# calling the setup function
setup(
name = NAME,
version = VERSION,
description = DESCRIPTION,
long_description = LONG_DESCRIPTION,
url = GIT,
author = AUTHOR,
author_email = EMAIL,
license = 'MIT',
packages = find_packages(exclude=['docs', 'examples']),
classifiers = CLASSIFIERS,
install_requires = REQUIREMENTS,
keywords = KEYWORDS,
data_files = [(GPIO_LIB_PATH, [
'{0}dummy.so'.format(GPIO_LIB_PATH),
'{0}gpio.so'.format(GPIO_LIB_PATH)
])],
project_urls = {
'Source': GIT,
'Bug Reports': ISSUES,
'Wiki': WIKI,
},
)
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment