Release 1.4.0 (#253)

1.4.0 Release

* Bug fix Modbus TCP client reading incomplete data
* Check for slave unit id before processing the request for serial clients
* Bug fix serial servers with Modbus Binary Framer
* Bug fix header size for ModbusBinaryFramer
* Bug fix payload decoder with endian Little
* Payload builder and decoder can now deal with the wordorder as well of 32/64 bit data.
* Support Database slave contexts (SqlStore and RedisStore)
* Custom handlers could be passed to Modbus TCP servers
* Asynchronous Server could now be stopped when running on a seperate thread (StopServer)
* Signal handlers on Asyncronous servers are now handled based on current thread
* Registers in Database datastore could now be read from remote clients
* Fix examples in contrib (message_parser.py/message_generator.py/remote_server_context)
* Add new example for SqlStore and RedisStore (db store slave context)
* Fix minor comaptibility issues with utilities.
* Update test requirements
* Update/Add new unit tests
* Move twisted requirements to extra so that it is not installed by default on pymodbus installtion

.github/ISSUE_TEMPLATE.md

@@ -14,6 +14,9 @@ Before opening a new issue, make sure you do the following:
 * Pymodbus:
 * Modbus Hardware (if used): 
 
+### Pymodbus Specific
+* Server: tcp/rtu/ascii - sync/async
+* Client: tcp/rtu/ascii - sync/async
 
 ### Description
 

.gitignore

@@ -7,7 +7,7 @@ pymodbus.egg-info/
 .vscode
 .idea
 .noseids
-
+*.db
 .idea/
 .tox/
 doc/api/epydoc/html/
@@ -20,3 +20,13 @@ pymodbus/datastore/__pycache__/
 pymodbus/internal/__pycache__/
 pymodbus/server/__pycache__/
 test/__pycache__/
+**/pymodbus.db
+/.eggs/
+/.cache/
+/doc/sphinx/doctrees/
+/doc_new/
+/doc/quality/
+/doc/pymodbus.pdf
+/doc/sphinx/
+/doc/html/
+/doc/_build/

.readthedocs.yml

@@ -0,0 +1,9 @@
+# Build PDF & ePub
+formats:
+    - epub
+    - pdf
+requirements_file: requirements-docs.txt
+python:
+    extra_requirements:
+        - twisted
+        - documents

CHANGELOG.rst

@@ -1,3 +1,22 @@
+Version 1.4.0
+------------------------------------------------------------
+* Bug fix Modbus TCP client reading incomplete data
+* Check for slave unit id before processing the request for serial clients
+* Bug fix serial servers with Modbus Binary Framer
+* Bug fix header size for ModbusBinaryFramer
+* Bug fix payload decoder with endian Little
+* Payload builder and decoder can now deal with the wordorder as well of 32/64 bit data.
+* Support Database slave contexts (SqlStore and RedisStore)
+* Custom handlers could be passed to Modbus TCP servers
+* Asynchronous Server could now be stopped when running on a seperate thread (StopServer)
+* Signal handlers on Asyncronous servers are now handled based on current thread
+* Registers in Database datastore could now be read from remote clients
+* Fix examples in contrib (message_parser.py/message_generator.py/remote_server_context)
+* Add new example for SqlStore and RedisStore (db store slave context)
+* Fix minor comaptibility issues with utilities.
+* Update test requirements
+* Update/Add new unit tests
+* Move twisted requirements to extra so that it is not installed by default on pymodbus installtion
 
 Version 1.3.2
 ------------------------------------------------------------

Makefile

@@ -16,7 +16,8 @@ default:
 	@echo '    make check      check coding style (PEP-8, PEP-257)'
 	@echo '    make test       run the test suite, report coverage'
 	@echo '    make tox        run the tests on all Python versions'
-	@echo '    make clean      cleanup all temporary files'
+	@echo '    make docs        creates sphinx documentation in html'
+	@echo '    make clean        cleanup all temporary files'
 	@echo
 
 install:
@@ -45,8 +46,8 @@ tox: install
 	@pip install --quiet tox && tox
 
 docs: install
-	@pip install --quiet sphinx
-	@cd doc/sphinx && sphinx-build -nb html -d doctrees . html
+	@pip install --quiet --requirement=requirements-docs.txt
+	@cd doc && make html
 
 publish: install
 	git push origin && git push --tags origin
@@ -57,8 +58,8 @@ publish: install
 	$(MAKE) clean
 
 clean:
-	@rm -Rf *.egg .cache .coverage .tox build dist docs/build htmlcov
-	@find -depth -type d -name __pycache__ -exec rm -Rf {} \;
-	@find -type f -name '*.pyc' -delete
+	@rm -Rf *.egg .eggs *.egg-info *.db .cache .coverage .tox build dist docs/build htmlcov doc/_build test/.Python test/pip-selfcheck.json test/lib/ test/include/ test/bin/
+	@find . -depth -type d -name __pycache__ -exec rm -Rf {} \;
+	@find . -type f -name '*.pyc' -delete
 
 .PHONY: default install reset check test tox docs publish clean

doc/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = PyModbus
+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)

doc/changelog.rst

@@ -0,0 +1 @@
+.. include:: ../CHANGELOG.rst

doc/conf.py

@@ -0,0 +1,179 @@
+# -*- coding: utf-8 -*-
+#
+# PyModbus documentation build configuration file, created by
+# sphinx-quickstart on Wed Dec 20 12:31:10 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# 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
+parent_dir = os.path.abspath(os.pardir)
+# examples = os.path.join(parent_dir, "examples")
+example_contrib = os.path.join(parent_dir, "examples/contrib")
+example_common = os.path.join(parent_dir, "examples/common")
+example_gui = os.path.join(parent_dir, "examples/gui")
+
+sys.path.insert(0, os.path.abspath(os.pardir))
+sys.path.append(example_common)
+sys.path.append(example_contrib)
+sys.path.append(example_gui)
+# sys.path.extend([examples, example_common, example_contrib, example_gui])
+# sys.path.insert(0, os.path.abspath('../'))
+
+
+# -- 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']
+
+# 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'
+
+# General information about the project.
+project = u'PyModbus'
+copyright = u'2017, Sanjay'
+author = u'Sanjay'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = u'1.4.0'
+# The full version, including alpha/beta/rc tags.
+release = u'1.4.0'
+
+# 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 = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to 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 = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- 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 = 'sphinx_rtd_theme'
+
+# 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.
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+html_sidebars = {
+    '**': [
+        'relations.html',  # needs 'show_related': True theme option to display
+        'searchbox.html',
+    ]
+}
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'PyModbusdoc'
+
+
+# -- 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, 'PyModbus.tex', u'PyModbus Documentation',
+     u'Sanjay', '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, 'pymodbus', u'PyModbus 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, 'PyModbus', u'PyModbus Documentation',
+     author, 'PyModbus', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

doc/sphinx/index.rst → doc/index.rst

@@ -1,23 +1,24 @@
 .. PyModbus documentation master file, created by
-   sphinx-quickstart on Tue Apr 14 19:11:16 2009.
+   sphinx-quickstart on Wed Dec 20 12:31:10 2017.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
 Welcome to PyModbus's documentation!
 ====================================
 
-Contents:
-
 .. toctree::
    :maxdepth: 2
+   :caption: Contents:
+
+   readme.rst
+   changelog.rst
+   source/example/modules.rst
+   source/library/modules.rst
 
-   examples/index.rst
-   library/index.rst
 
 Indices and tables
 ==================
 
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-