Finished release 0.6.

.gitignore

@@ -17,7 +17,6 @@ develop-eggs
 .installed.cfg
 lib
 lib64
-__pycache__
 
 # Installer logs
 pip-log.txt
@@ -35,4 +34,9 @@ nosetests.xml
 .project
 .pydevproject
 
-.idea
+# Complexity
+output/*.html
+output/*/index.html
+
+# Sphinx
+docs/_build

.travis.yml

@@ -0,0 +1,17 @@
+# Config file for automatic testing at travis-ci.org
+
+branches:
+    only:
+        - develop
+
+language: python
+
+python:
+  - "2.7"
+  - "2.6"
+
+# command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors
+install: pip install -r requirements.txt
+
+# command to run tests, e.g. python setup.py test
+script: python setup.py test

AUTHORS.rst

@@ -0,0 +1,13 @@
+=======
+Credits
+=======
+
+Development Lead
+----------------
+
+* Ian McCracken <ian.mccracken@gmail.com>
+
+Contributors
+------------
+
+None yet. Why not be the first?

CONTRIBUTING.rst

@@ -0,0 +1,111 @@
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every
+little bit helps, and credit will always be given. 
+
+You can contribute in many ways:
+
+Types of Contributions
+----------------------
+
+Report Bugs
+~~~~~~~~~~~
+
+Report bugs at https://github.com/iancmcc/ouimeaux/issues.
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+Fix Bugs
+~~~~~~~~
+
+Look through the GitHub issues for bugs. Anything tagged with "bug"
+is open to whoever wants to implement it.
+
+Implement Features
+~~~~~~~~~~~~~~~~~~
+
+Look through the GitHub issues for features. Anything tagged with "feature"
+is open to whoever wants to implement it.
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+
+ouimeaux could always use more documentation, whether as part of the 
+official ouimeaux docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+Submit Feedback
+~~~~~~~~~~~~~~~
+
+The best way to send feedback is to file an issue at https://github.com/iancmcc/ouimeaux/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+Get Started!
+------------
+
+Ready to contribute? Here's how to set up `ouimeaux` for local development.
+
+1. Fork the `ouimeaux` repo on GitHub.
+2. Clone your fork locally::
+
+    $ git clone git@github.com:your_name_here/ouimeaux.git
+
+3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
+
+    $ mkvirtualenv ouimeaux
+    $ cd ouimeaux/
+    $ python setup.py develop
+
+4. Create a branch for local development::
+
+    $ git checkout -b name-of-your-bugfix-or-feature
+   
+   Now you can make your changes locally.
+
+5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
+
+    $ flake8 ouimeaux tests
+    $ python setup.py test
+    $ tox
+
+   To get flake8 and tox, just pip install them into your virtualenv. 
+
+6. Commit your changes and push your branch to GitHub::
+
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+
+7. Submit a pull request through the GitHub website.
+
+Pull Request Guidelines
+-----------------------
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated. Put
+   your new functionality into a function with a docstring, and add the
+   feature to the list in README.rst.
+3. The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check 
+   https://travis-ci.org/iancmcc/ouimeaux/pull_requests
+   and make sure that the tests pass for all supported Python versions.
+
+Tips
+----
+
+To run a subset of tests::
+
+	$ python -m unittest tests.test_ouimeaux

HISTORY.rst

@@ -0,0 +1,75 @@
+.. :changelog:
+
+History
+-------
+
+Release 0.6 (January 25, 2014)
+++++++++++++++++++++++++++++++++
+- Added signals framework
+- Fixed #16, #19, #22: Defensively resubscribe to events when device responds with an error
+- Fixed #15: Signals framework includes relevant device when sending signal
+- Refactored structure, added Sphinx docs
+
+Release 0.5.3 (January 25, 2014)
+++++++++++++++++++++++++++++++++
+- Fixed #20: Allow timeout in environment.wait()
+- Fixed #21: Add Insight support
+
+Release 0.5.2 (November 23, 2013)
++++++++++++++++++++++++++++++++++
+- Fixed #14: Indicate Connection:close header to avoid logging when WeMo sends
+  invalid HTTP response.
+
+Release 0.5.1 (November 9, 2013)
+++++++++++++++++++++++++++++++++
+- Fixed #10: Updated subscriber listener to use more reliable method of
+  retrieving non-loopback IP address; updated docs to fix typo in listener
+  registration example (thanks to @benhoyle, @francxk)
+- Fixed #11: Remove instancemethod objects before attempting to pickle devices
+  in the cache (thanks @piperde, @JonPenner, @tomtomau, @masilu77)
+
+Release 0.5 (October 14, 2013)
++++++++++++++++++++++++++++++++
+- Added fuzzy matching of device name when searching/toggling from command line
+- Added ``status`` mode to print status for all devices
+- Added ``switch status`` mode to print status for specific device
+- Added flags for all command-line options
+- Fixed #9: Removed unused fcntl import that precluded Windows usage (thanks to
+  @deepseven)
+
+Release 0.4.3 (August 31, 2013)
++++++++++++++++++++++++++++++++
+- Used new method of obtaining local IP for discovery that is less likely to
+  return loopback
+- Exit with failure and instructions for solution if loopback IP is used
+- Updated installation docs to include python-dev and pip instructions (patch
+  by @fnaard)
+- Fixed README inclusion bug that occasionally broke installation via pip.
+- Added ``--debug`` option to enable debug logging to stdout
+
+Release 0.4 (August 17, 2013)
++++++++++++++++++++++++++++++
+- Fixed #7: Added support for light switch devices (patch by nschrenk).
+- Fixed #6: Added "wemo clear" command to clear the device cache.
+
+Release 0.3 (May 25, 2013)
+++++++++++++++++++++++++++
+- Fixed #4: Added ability to specify ip:port for discovery server binding. Removed
+  documentation describing need to disable SSDP service on Windows.
+- Fixed #5: Added device cache for faster results.
+- Added configuration file.
+- Added ability to configure aliases for devices to avoid quoting strings on
+  the command line.
+- Added 'toggle' command to command line switch control.
+
+Release 0.2 (April 21, 2013)
+++++++++++++++++++++++++++++++
+- Fixed #1: Added ability to subscribe to motion and switch state change events.
+- Added Windows installation details to README (patch by @brianpeiris)
+- Cleaned up UDP server lifecycle so rediscovery doesn't try to start it back up.
+
+Release 0.1 (February 2, 2013)
+++++++++++++++++++++++++++++++
+- Initial release.
+
+* First release on PyPI.

LICENSE

@@ -1,23 +1,12 @@
-Copyright (c) 2013, Ian McCracken
+Copyright (c) 2014, Ian McCracken
 All rights reserved.
 
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 
- * Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer.
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 
- * Redistributions in binary form must reproduce the above copyright notice, this
-   list of conditions and the following disclaimer in the documentation and/or 
-   other materials provided with the distribution.
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+* Neither the name of ouimeaux nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

MANIFEST.in

@@ -1,3 +1,6 @@
+include AUTHORS.rst
+include CONTRIBUTING.rst
+include HISTORY.rst
 include LICENSE
-include MANIFEST.in
 include README.rst
+include requirements.txt

Makefile

@@ -0,0 +1,54 @@
+.PHONY: clean-pyc clean-build docs
+
+help:
+	@echo "clean-build - remove build artifacts"
+	@echo "clean-pyc - remove Python file artifacts"
+	@echo "lint - check style with flake8"
+	@echo "test - run tests quickly with the default Python"
+	@echo "testall - run tests on every Python version with tox"
+	@echo "coverage - check code coverage quickly with the default Python"
+	@echo "docs - generate Sphinx HTML documentation, including API docs"
+	@echo "release - package and upload a release"
+	@echo "sdist - package"
+
+clean: clean-build clean-pyc
+
+clean-build:
+	rm -fr build/
+	rm -fr dist/
+	rm -fr *.egg-info
+
+clean-pyc:
+	find . -name '*.pyc' -exec rm -f {} +
+	find . -name '*.pyo' -exec rm -f {} +
+	find . -name '*~' -exec rm -f {} +
+
+lint:
+	flake8 ouimeaux tests
+
+test:
+	python setup.py test
+
+test-all:
+	tox
+
+coverage:
+	coverage run --source ouimeaux setup.py test
+	coverage report -m
+	coverage html
+	open htmlcov/index.html
+
+docs:
+	rm -f docs/ouimeaux.rst
+	rm -f docs/modules.rst
+	sphinx-apidoc -o docs/ ouimeaux
+	$(MAKE) -C docs clean
+	$(MAKE) -C docs html
+	open docs/_build/html/index.html
+
+release: clean
+	python setup.py sdist upload
+
+sdist: clean
+	python setup.py sdist
+	ls -l dist