#210 gitattributes to exclude files from release

.coveragerc

@@ -0,0 +1,2 @@
+[report]
+show_missing = True

.gitattributes

@@ -0,0 +1,6 @@
+doc export-ignore
+test export-ignore
+examples export-ignore
+scripts export-ignore
+.* export-ignore
+

.gitignore

@@ -4,3 +4,19 @@ build/
 dist/
 pymodbus.egg-info/
 .coverage
+.vscode
+.idea
+.noseids
+
+.idea/
+.tox/
+doc/api/epydoc/html/
+.vscode/
+.venv
+__pycache__/
+pymodbus/__pycache__/
+pymodbus/client/__pycache__/
+pymodbus/datastore/__pycache__/
+pymodbus/internal/__pycache__/
+pymodbus/server/__pycache__/
+test/__pycache__/

.travis.yml

@@ -0,0 +1,32 @@
+sudo: false
+language: python
+matrix:
+  include:
+  - os: linux
+    python: "2.7"
+  - os: linux
+    python: "3.4"
+  - os: linux
+    python: "3.5"
+  - os: linux
+    python: "3.6"
+  - os: osx
+    language: generic
+before_install:
+  - if [ $TRAVIS_OS_NAME = osx ]; then brew update; fi
+  - if [ $TRAVIS_OS_NAME = osx ]; then brew install openssl; fi
+
+install:
+#  - scripts/travis.sh pip install pip-accel
+  - scripts/travis.sh pip install coveralls
+  - scripts/travis.sh pip install --requirement=requirements-checks.txt
+  - scripts/travis.sh pip install --requirement=requirements-tests.txt
+  - scripts/travis.sh LC_ALL=C pip install .
+script:
+#  - scripts/travis.sh make check
+  - scripts/travis.sh make test
+after_success:
+  - scripts/travis.sh coveralls
+branches:
+  except:
+    - /^[0-9]/

CHANGELOG.rst

@@ -1,6 +1,38 @@
-Version 1.2.0
+
+Version 1.3.2
+------------------------------------------------------------
+* ModbusSerialServer could now be stopped when running on a seperate thread.
+* Fix issue with server and client where in the frame buffer had values from previous unsuccesful transaction
+* Fix response length calculation for ModbusASCII protocol
+* Fix response length calculation ReportSlaveIdResponse, DiagnosticStatusResponse
+* Fix never ending transaction case when response is recieved without header and CRC
+* Fix tests
+
+Version 1.3.1
 ------------------------------------------------------------
+* Recall socket recv until get a complete response
+* Register_write_message.py: Observe skip_encode option when encoding a single register request
+* Fix wrong expected response length for coils and discrete inputs
+* Fix decode errors with ReadDeviceInformationRequest and  ReportSlaveIdRequest on Python3
+* Move MaskWriteRegisterRequest/MaskWriteRegisterResponse  to register_write_message.py from file_message.py
+* Python3 compatible examples [WIP]
+* Misc updates with examples
 
+Version 1.3.0.rc2
+------------------------------------------------------------
+* Fix encoding problem for ReadDeviceInformationRequest method on python3
+* Fix problem with the usage of ord in python3 while cleaning up receive buffer
+* Fix struct unpack errors with BinaryPayloadDecoder on python3 - string vs bytestring error
+* Calculate expected response size for ReadWriteMultipleRegistersRequest
+* Enhancement for ModbusTcpClient, ModbusTcpClient can now accept connection timeout as one of the parameter
+* Misc updates
+
+Version 1.3.0.rc1
+------------------------------------------------------------
+* Timing improvements over MODBUS Serial interface
+* Modbus RTU use 3.5 char silence before and after transactions
+* Bug fix on FifoTransactionManager , flush stray data before transaction
+* Update repository information
 * Added ability to ignore missing slaves
 * Added ability to revert to ZeroMode
 * Passed a number of extra options through the stack

Makefile

@@ -0,0 +1,64 @@
+# Makefile for the `pymodbus' package.
+
+WORKON_HOME ?= $(HOME)/.virtualenvs
+VIRTUAL_ENV ?= $(WORKON_HOME)/pymodbus
+PATH := $(VIRTUAL_ENV)/bin:$(PATH)
+MAKE := $(MAKE) --no-print-directory
+SHELL = bash
+
+default:
+	@echo 'Makefile for pymodbus'
+	@echo
+	@echo 'Usage:'
+	@echo
+	@echo '    make install    install the package in a virtual environment'
+	@echo '    make reset      recreate the virtual environment'
+	@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
+
+install:
+	@test -d "$(VIRTUAL_ENV)" || mkdir -p "$(VIRTUAL_ENV)"
+	@test -x "$(VIRTUAL_ENV)/bin/python" || virtualenv --quiet "$(VIRTUAL_ENV)"
+	@test -x "$(VIRTUAL_ENV)/bin/pip" || easy_install pip
+	@pip install --quiet --requirement=requirements.txt
+	@pip uninstall --yes pymodbus &>/dev/null || true
+	@pip install --quiet --no-deps --ignore-installed .
+
+reset:
+	$(MAKE) clean
+	rm -Rf "$(VIRTUAL_ENV)"
+	$(MAKE) install
+
+check: install
+	@pip install --upgrade --quiet --requirement=requirements-checks.txt
+	@flake8
+
+test: install
+	@pip install --quiet --requirement=requirements-tests.txt
+	@nosetests --with-coverage --cover-html
+	@coverage report --fail-under=90
+
+tox: install
+	@pip install --quiet tox && tox
+
+docs: install
+	@pip install --quiet sphinx
+	@cd doc/sphinx && sphinx-build -nb html -d doctrees . html
+
+publish: install
+	git push origin && git push --tags origin
+	$(MAKE) clean
+	pip install --quiet twine wheel
+	python setup.py sdist bdist_wheel
+	twine upload dist/*
+	$(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
+
+.PHONY: default install reset check test tox docs publish clean

README.rst

@@ -1,3 +1,13 @@
+.. image:: https://travis-ci.org/riptideio/pymodbus.svg?branch=master
+   :target: https://travis-ci.org/riptideio/pymodbus 
+
+.. image:: https://badges.gitter.im/Join%20Chat.svg
+   :target: https://gitter.im/pymodbus_dev/Lobby
+
+.. image:: https://readthedocs.org/projects/pymodbus-n/badge/?version=latest
+   :target: http://pymodbus-n.readthedocs.io/en/latest/?badge=latest
+   :alt: Documentation Status
+
 ============================================================
 Summary
 ============================================================
@@ -49,6 +59,9 @@ a user to test as many devices as their base operating system will allow (*allow
 in this case means how many Virtual IP addresses are allowed).
 
 For more information please browse the project documentation:
+
+http://riptideio.github.io/pymodbus/ 
+or
 http://readthedocs.org/docs/pymodbus/en/latest/index.html
 
 ------------------------------------------------------------
@@ -72,7 +85,8 @@ need, feel free to submit them so others can benefit.
 Also, if you have questions, please ask them on the mailing list
 so that others can benefit from the results and so that I can
 trace them. I get a lot of email and sometimes these requests
-get lost in the noise: http://groups.google.com/group/pymodbus
+get lost in the noise: http://groups.google.com/group/pymodbus or 
+at gitter:  https://gitter.im/pymodbus_dev/Lobby
 
 ------------------------------------------------------------
 Installing
@@ -111,19 +125,46 @@ like your device tested, I accept devices via mail or by IP address.
 That said, the current work mainly involves polishing the library as
 I get time doing such tasks as:
 
+  * Make PEP-8 compatible and flake8 ready
   * Fixing bugs/feature requests
   * Architecture documentation
   * Functional testing against any reference I can find
   * The remaining edges of the protocol (that I think no one uses)
-
+
+------------------------------------------------------------
+Development Instructions
+------------------------------------------------------------
+The current code base is compatible with both py2 and py3.
+Use make to perform a range of activities
+
+::
+
+    $ make
+       Makefile for pymodbus
+
+    Usage:
+
+     make install    install the package in a virtual environment
+     make reset      recreate the virtual environment
+     make check      check coding style (PEP-8, PEP-257)
+     make test       run the test suite, report coverage
+     make tox        run the tests on all Python versions
+     make clean      cleanup all temporary files 
+
+------------------------------------------------------------
+Contributing
+------------------------------------------------------------
+Just fork the repo and raise your PR against `dev` branch.
+
 ------------------------------------------------------------
 License Information
 ------------------------------------------------------------
 
 Pymodbus is built on top of code developed from/by:
   * Copyright (c) 2001-2005 S.W.A.C. GmbH, Germany.
   * Copyright (c) 2001-2005 S.W.A.C. Bohemia s.r.o., Czech Republic.
-  * Hynek Petrak <[email protected]>
+
+  * Hynek Petrak, https://github.com/HynekPetrak
   * Twisted Matrix
 
 Released under the BSD License