Merge branch 'release/0.0.1'

README.md

@@ -1,2 +1,44 @@
 # pyseneye
-A library for interacting with the Seneye range or aquarium and pond sensors
+
+[![Build Status](https://travis-ci.org/mcclown/pyseneye.svg?branch=master)](https://travis-ci.org/mcclown/pyseneye)
+[![Coverage Status](https://coveralls.io/repos/mcclown/pyseneye/badge.svg?branch=master&service=github)](https://coveralls.io/github/mcclown/pyseneye?branch=master)
+
+
+A module for working with the Seneye range of aquarium and pond sensors. Support is provided for the HID/USB driver for the device although it is intended to add support for their API later.
+
+When using this, readings will not be synced to the Seneye.me cloud service. This module is in no way endorsed by Seneye and you use it at your own risk.
+
+Generated documentation can be found [here](http://pyseneye.readthedocs.io/en/latest/)
+
+Quickstart
+----------
+
+Install pyseneye using `pip`: `$ pip install pyseneye`. Once that is complete you can import the SUDevice class and connect to your device.
+
+```python
+>>> from pyseneye.sud import SUDDevice, Action
+>>> d = SUDevice()
+```
+
+Once the class is initialised you can put the Seneye into interactive mode and then retrieve sensor readings.
+
+```python
+>>> d.action(Action.ENTER_INTERACTIVE_MODE)
+>>> s = d.action(Action.SENSOR_READING)
+>>> s.ph
+8.16
+>>> s.nh3
+0.007
+>>> s.temperature
+25.125
+>>> d.action(Action.LEAVE_INTERACTIVE_MODE)
+>>> d.close()
+```
+
+You need access to the USB device, so these calls may require elevated privileges.
+
+Issues & Questions
+------------------
+
+If you have any issues, or questions, please feel free to contact me, or open an issue on GitHub
+

README.rst

@@ -0,0 +1,56 @@
+pyseneye
+========
+
+|Build Status| |Coverage Status|
+
+A module for working with the Seneye range of aquarium and pond sensors.
+Support is provided for the HID/USB driver for the device although it is
+intended to add support for their API later.
+
+When using this, readings will not be synced to the Seneye.me cloud
+service. This module is in no way endorsed by Seneye and you use it at
+your own risk.
+
+Generated documentation can be found
+`here <http://pyseneye.readthedocs.io/en/latest/>`__
+
+Quickstart
+----------
+
+Install pyseneye using ``pip``: ``$ pip install pyseneye``. Once that is
+complete you can import the SUDevice class and connect to your device.
+
+.. code:: python
+
+    >>> from pyseneye.sud import SUDDevice, Action
+    >>> d = SUDevice()
+
+Once the class is initialised you can put the Seneye into interactive
+mode and then retrieve sensor readings.
+
+.. code:: python
+
+    >>> d.action(Action.ENTER_INTERACTIVE_MODE)
+    >>> s = d.action(Action.SENSOR_READING)
+    >>> s.ph
+    8.16
+    >>> s.nh3
+    0.007
+    >>> s.temperature
+    25.125
+    >>> d.action(Action.LEAVE_INTERACTIVE_MODE)
+    >>> d.close()
+
+You need access to the USB device, so these calls may require elevated
+privileges.
+
+Issues & Questions
+------------------
+
+If you have any issues, or questions, please feel free to contact me, or
+open an issue on GitHub
+
+.. |Build Status| image:: https://travis-ci.org/mcclown/pyseneye.svg?branch=master
+   :target: https://travis-ci.org/mcclown/pyseneye
+.. |Coverage Status| image:: https://coveralls.io/repos/mcclown/pyseneye/badge.svg?branch=master&service=github
+   :target: https://coveralls.io/github/mcclown/pyseneye?branch=master

docs/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,196 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, '/home/steve/git/pyseneye/pyseneye')
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'pyseneye'
+copyright = '2019, Stephen Mc Gowan'
+author = 'Stephen Mc Gowan'
+
+#version = ''
+# The full version, including alpha/beta/rc tags
+#release = ''
+
+import pkg_resources
+try:
+    release = pkg_resources.get_distribution(project).version
+except pkg_resources.DistributionNotFound:
+    print 'To build the documentation, The distribution information of seneye'
+    print 'Has to be available.  Either install the package into your'
+    print 'development environment or run "setup.py develop" to setup the'
+    print 'metadata.  A virtualenv is recommended!'
+    sys.exit(1)
+del pkg_resources
+
+version = '.'.join(release.split('.')[:2])
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.todo',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = 'en'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'nature'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'pyseneyedoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'pyseneye.tex', 'pyseneye Documentation',
+     'Author', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'pyseneye', 'pyseneye Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'pyseneye', 'pyseneye Documentation',
+     author, 'pyseneye', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for todo extension ----------------------------------------------
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True

docs/index.rst

@@ -0,0 +1,21 @@
+.. pyseneye documentation master file, created by
+   sphinx-quickstart on Sat Feb 23 20:48:16 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to pyseneye's documentation!
+====================================
+
+.. toctree::
+   :maxdepth: 4
+   :caption: Contents:
+
+   pyseneye
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd