Merge pull request #6 from scy-phy/pypi

Pypi

LICENSE

@@ -1,6 +1,4 @@
-MiniCPS is a lightweight simulator for accurate network traffic in an
-industrial control system, with basic support for physical layer interaction.
-Copyright (C) 2015 scy-phy
+Copyright (C) 2017 Daniele Antonioli
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the "Software"),

Makefile

@@ -20,7 +20,9 @@ TESTER_TRAVIS = nosetests
 TESTER_OPTS = -s -v --exe  --rednose
 TESTER_OPTS_COV_HTML = $(TESTER_OPTS) --with-coverage --cover-html
 
-# http://stackoverflow.com/questions/3931741/why-does-make-think-the-target-is-up-to-date
+UPLOADER=twine
+# }}}
+
 .PHONY: tests tests-travis clean
 
 # TOY {{{1
@@ -35,6 +37,8 @@ test-toy:
 test-toy-cover:
 	cd examples/toy; $(TESTER) $(TESTER_OPTS_COV_HTML) tests.py; cd ../..
 
+# }}}
+
 # SWAT {{{1
 
 swat-s1:
@@ -49,9 +53,9 @@ test-swat-s1:
 # 	$(PYTHON) $(PYTHON_OPTS) tutorial/run.py
 # 	cd ../..
 # test-swat:
-# 	$(TESTER) $(TESTER_OPTS) examples/swat/tests
-
+# 	$(TESTER) $(TESTER_OPTS) examples/swat/test
 
+# }}}
 
 # TESTS {{{1
 
@@ -70,6 +74,7 @@ tests:
 # --cov set the covered FS
 # test-cov:
 # 	sudo $(TESTER) $(TESTER_OPTS_COV) minicps_tests.py
+# }}}
 
 # MANUAL {{{2
 test-mcps:
@@ -104,9 +109,11 @@ test-devices:
 
 test-device:
 	$(TESTER) $(TESTER_OPTS) tests/devices_tests.py:TestDevice
+# }}}
 
+# }}}
 
-# clean {{{1
+# CLEAN {{{1
 clean: clean-cover clean-pyc clean-logs
 
 clean-simulation:
@@ -130,3 +137,14 @@ clean-cpppo:
 clean-mininet:
 	sudo mn -c
 
+# }}}
+
+# PYPI {{{1
+
+pypi-wheel:
+	./setup.py sdist bdist_wheel
+
+pypi-upload:
+	$(UPLOADER) upload dist/*
+
+# }}}

README.md

@@ -1,17 +1,17 @@
+[![PyPI version](https://badge.fury.io/py/minicps.svg)](https://badge.fury.io/py/minicps)
 [![Documentation Status](https://readthedocs.org/projects/minicps/badge/?version=latest)](http://minicps.readthedocs.io/en/latest/?badge=latest)
 [![Coverage Status][CS img]][Coverage Status]
 
 [Coverage Status]: https://travis-ci.org/scy-phy/minicps
 [CS img]: https://travis-ci.org/scy-phy/minicps.svg
 [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/hslatman/awesome-industrial-control-system-security)
-<!--- TODO: update link once PR is accepted -->
-
 
 # MiniCPS #
 
-MiniCPS is a lightweight simulator for accurate network traffic in an
-industrial control system, with basic support for physical layer
-interaction.
+MiniCPS is a framework for Cyber-Physical Systems real-time simulation. It
+includes support for physical process and control devices simulation, and
+network emulation. It is build on top of
+[mininet](https://github.com/mininet/mininet).
 
 MiniCPS is developed by the [SCy-Phy](http://scy-phy.github.io/index.html)
-group from SUTD (Singapore Univeristy of Design and Technology).
+group from SUTD (Singapore University of Design and Technology).

RELEASES.md

@@ -1,6 +1,23 @@
-# Releases and change log
+# Releases and Changelog
 
-## Version 1.1.0 (2017-TODO-TODO)
+## Version 1.1.2 (2017-05-14)
+
+### Misc
+
+* Remove `example/swat` directory
+    * Kept some files in the `misc/` directory
+
+## Version 1.1.1 (2017-05-10)
+
+### Pypi
+
+* [![PyPI version](https://badge.fury.io/py/minicps.svg)](https://badge.fury.io/py/minicps) requires `wheel`
+
+### Modbus
+
+* Fix `write_coil` bug
+
+## Version 1.1.0 (2017-04-01)
 
 ### Public API
 
@@ -15,6 +32,7 @@
 * Added `rednose` for better user interface
 * Added `raises` decorator to test for expected Exceptions
 * Bug fixes
+* Removed `tests/utils_tests.py`
 
 
 ### Misc

docs/conf.py

@@ -68,7 +68,7 @@
 # The short X.Y version.
 version = '1.1'
 # The full version, including alpha/beta/rc tags.
-release = '1.1.0'
+release = '1.1.2'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/userguide.rst

@@ -18,6 +18,8 @@ This page summarizes the basic installation, configuration and testing of
 MiniCPS. We provide a tutorial for beginners here: :ref:`swat-tutorial`. If
 you need more information about a specific topic see :ref:`misc`.
 
+.. }}}
+
 
 .. INSTALLATION {{{2