Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
admin committed Sep 8, 2019
1 parent b115643 commit f63c696
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 12 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# ekmmeters 0.2.4
# ekmmeters 0.2.5

Python API for the EKM Omnimeter Serial Interface

The goal of this library is to provide a reliable and flexible interface to version 3 and version 4 EKM Omnnimeters.
The goal of this library is to provide a reliable and flexible interface to the EKM Omnimeter v.3, EKM Omnimeter, v.4, and EKM Omnimeter v.5

To get started, you can 'pip install ekmmeters' or download the single required Python file, ekmmeters.py, to your working directory and include with 'from ekmmeters import *'.
To get started, you can 'pip install ekmmeters', 'pip3 install ekmmeters' or download the single required Python file, ekmmeters.py, to your working directory and include with 'from ekmmeters import *'.

Adaptable examples for all supported Omnimeter commands can be found at <a href="http://ekmmeters.readthedocs.io/en/latest/">
readthedocs.org</a>.
Expand All @@ -16,7 +16,7 @@ More experienced Python users will find appropriate methods to support agents ag

#Fine Print

The library is a single file and pure Python. You can install with "pip ekmmeters" or download ekmmeters.py and place it in your project directory. There are no external dependencies for ekmmeters.py beyond the pypi packages json, collections, importlib and pyserial.
The library is a single file and pure Python. You can install with 'pip ekmmeters', 'pip3 install ekmmeters' or download ekmmeters.py and place it in your project directory. There are no external dependencies for ekmmeters.py beyond the pypi packages json, collections, importlib and pyserial.

Unit tests require the unittests2 pypi package, along with random and ConfigParser. The unit tests are not included
in the pypi release, and additional packages may be required for unit tests in the future. The documentation for readthedocs.org was built under Sphinx 1.35. Google style docstrings are used exclusively, and read via the Sphinx napoleon extension. Docs can be built locally with the sphinx_rtd_theme pypi package installed.
Expand All @@ -27,4 +27,4 @@ There is no required third party tool set for editing the library. However, Pyc

The software is provided under an MIT License. The MIT license allows you to use this library for any personal or commercial project, without an obligation to release any of your work as open source.

(c) 2015, 2016 EKM Metering, as appropriate.
(c) 2015-2019 EKM Metering, Inc. as appropriate.
11 changes: 4 additions & 7 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,20 @@

setup(
name = "ekmmeters",
version = "0.2.4",
version = "0.2.5",
license='MIT',
description='Python API for V3 and V4 EKM Omnimeters',
author = 'EKM Metering',
author_email = "info@ekmmetering.com",
url = 'https://github.com/ekmmetering/ekmmeters',
download_url = 'https://github.com/ekmmetering/ekmmeters/tarball/0.2.4',
classifiers=[
'Development Status :: 5 - Production/Stable',
'Intended Audience :: Developers',
'License :: OSI Approved :: MIT License',
'Programming Language :: Python :: 2.6',
'Programming Language :: Python :: 2.7',
'License :: OSI Approved :: MIT License'
],
py_modules=['ekmmeters'],
install_requires=[
'OrderedDict==1.1',
'pyserial==3.0.1',
'OrderedDict>=1.1',
'pyserial>=3.0.1',
]
)

0 comments on commit f63c696

Please sign in to comment.