Auto-commit for new-version

CHANGELOG.txt

@@ -1,10 +1,25 @@
 Changelog
 *********
 
-python_openzwave 0.4.3.x:
+python_openzwave 0.4.6.x:
+   * First try to support Windows in pip
+
+python_openzwave 0.4.5.x:
+   * Fix bug in node statistics and add test.
+
+   * Update Makefile to build flavor dev
+
+   * Update pyozw_check.
+
+   * Update default flavor : check cython is here before choosing
+     shared
+
+   * Fix controller.update_ozw_config when directory isn't writable
+
+python_openzwave 0.4.4.x:
    * Add new options to pyozw_check to list nodes on network.
 
-python_openzwave 0.4.2.x:
+python_openzwave 0.4.3.x:
    * Fix bug in default flavor.
 
 python_openzwave 0.4.1.x:

DEVEL.txt

@@ -5,88 +5,44 @@ Developers information
 How to develop for python-openzwave
 ===================================
 
-Get the sources
+Fork the project on Github.
 
-   git clone https://github.com/OpenZWave/python-openzwave
+Get the sources :
+
+   git clone https://github.com/yourname/python-openzwave
 
 You can install all the dependances to develop for python-openzwave
 using the command :
 
    sudo make developer-deps
 
-You must now install python-openzwave in develop mode
+You must now install python-openzwave in develop mode. Depending on
+which python version you prefer, use :
+
+   make venv2-dev
 
-   make develop
+or
 
-Your password will be asked (by sudo) for installing eggs in your
-local directory.
+   make venv2-dev
+
+Keep in mind that your updates must be python 2 / python 3 compatible.
 
 Develop, test, debug, test, ... :)
 
 Update the documentation if needed. You surely found the documentation
 useful, so please keep it up to date.
 
-You can create an account on travis or docker to run the tests.
-
-At last but not least, submit your request.
-
-
-How to develop for libopenzwave (was python-openzwave-lib)
-==========================================================
-
-After updating the pyx, you need to reinstall it. Otherwise, your
-changes will not be applied :
-
-   make develop
-
-
-Tests
-=====
-
-First, install the dependances :
-
-   sudo make tests-deps
-
-To launch all the tests suite (about 140 tests), use the following
-command :
+It a good idea to add automatic tests.
 
-   make tests
+Launch the full test suite (for python 2 and python 3) :
 
-To launch particular tests :
+   make venv-tests
 
-   nosetests --verbosity=2 tests/api/test_controller_command.py
+At last but not least, submit your request with the result of tests in
+the comment.
 
-Some tests need manual operations (ie to add a node, to remove one,
-...). For example, to test the remove node, use :
-
-   export MANUALSKIP='False' && nosetests --verbosity=2 tests/api/test_controller_command.py -m test_150 && unset MANUALSKIP
-   test_150_command_remove_node_and_wait_for_user (tests.api.test_controller_command.TestControllerCommand) ... ok
-
-   ----------------------------------------------------------------------
-   Ran 1 test in 16.031s
-
-   OK
-
-You should push the inclusion button of the node before the end of the
-test.
-
-Some tests don't need a ZWave Stick to be launched, so they can be run
-on the autobuilders (travis, docker, ...). Place them in the autobuild
-directory.
-
-Travis-ci, Docker Hub, nosetests and pylint are used to test quality
-of code. There reports are here :
-
-   * Docker : https://registry.hub.docker.com/u/bibi21000/python-
-     openzwave/
-
-   * Travis : https://travis-ci.org/bibi21000/python-openzwave
-
-   * Nosetests report
-
-   * Coverage report
-
-   * Pylint report
+If you don't follow the previous steps, your PR will be refused or
+letting in pending state until I've got time to test it.
 
 
 Documentation
@@ -96,97 +52,7 @@ First, install the dependances :
 
    sudo make doc-deps
 
-Documentation is managed with sphinx. Don't utpdate txt files (README,
-INSTALL, ...), update the RST sources in docs. Use the following
-commands to generate all docs files (txt, html and joomla)
-
-You need to have installed python-openzwave (in either develop or
-install mode) before generating the documentation.
-
-   make docs
-
-
-Static vs dynamic (or shared)
-=============================
-
-The openzwave (c++) lib needs to run as a singleton : it means that it
-MUST have only one instance of the manager running on your computer.
-
-There is 2 ways of linking libraries with a program :
-
-   * static : includes a copy of the library in your binary program.
-     This means that your program has its own instance of the library.
-     This the way the install.sh runs. So you CAN'T have another
-     program (like the control-panel) running when using the python-
-     openzwave library
-
-   * dynamic or shared : includes a link to the library in your
-     binary program. This means that your program share the library
-     with other programs. In this case, the instance is owned directly
-     by the library. This the way the debian package works. So you CAN
-     have another program running when using the python-openzwave
-     library. Of course, this program MUST use the shared library too.
-
-
-About sudo
-==========
-
-If you are like me and don't like root (and sudo), you can use the
-following tip to install packages via pip :
-
-Look at your python local library, it should looks like :
-
-   ls -lisa /usr/local/lib/python2.7/dist-packages/
-   total 2428
-   1445174  12 drwxrwsr-x 115 root staff  12288 avril  9 21:35 .
-   1445172   4 drwxrwsr-x   4 root staff   4096 mai    2  2014 ..
-   1457164   4 drwxr-sr-x   5 root staff   4096 nov.  26  2013 actdiag
-   1715480   4 drwxr-sr-x   2 root staff   4096 nov.  26  2013 actdiag-0.5.1.egg-info
-   1457163   4 -rw-r--r--   1 root staff   1004 nov.  26  2013 actdiag_sphinxhelper.py
-   1457172   4 -rw-r--r--   1 root staff    620 nov.  26  2013 actdiag_sphinxhelper.pyc
-   ....
-
-So, add your common user to the staff group :
-
-   sudo usermod -a -G staff userName
-
-Add the write right to the group staff
-
-   sudo chmod -Rf g+w /usr/local/lib/python2.7/dist-packages/
-
-And now, it's time log off and log on. Groups are checked when you
-open the session.
-
-You can now install your packages without sudo.
-
-
-Python3 and virtualenv
-======================
-
-Python 3 is actually not supported.
-
-A branch (python3) has been created with a special Dockerfile. It
-build python-openzwave and launch some tests. This branch is
-automatically merged from master at "make commit".
-
-So please, do not directly push under python3 branch. Make your
-developments under master or another branch.
-
-It's important for me have python2/python3 compatibilty in the master
-branch. cython can help for this :
-http://docs.cython.org/src/tutorial/strings.html
-
-The Makefile sill try to automatically configure your version of
-python (running python --version).
-
-If you want to install python-openzwave in a python virtual
-environnement, you should use something like :
-
-   make VIRTUAL_ENV=/path/to/my/venv ...
-
-If you use python 3 and your python executable is called python3 :
-
-   make PYTHON_EXEC=python3 ...
+Documentation is managed with sphinx.
 
-You can also put these variables in a CONFIG.make file instead of
-passing them to the command line
+Don't update txt and rst files (README, INSTALL, ...) in the root
+directory, update the RST sources in docs.