[BUGIFX 176] Fix dbus connection leak

.circleci/config.yml

@@ -0,0 +1,57 @@
+# Python CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-python/ for more details
+version: 2
+
+shared: &shared
+    working_directory: ~/repo
+    steps:
+      - checkout
+
+      - run:
+          name: Install dependencies
+          command: |
+            sudo apt-get install -y dbus libdbus-1-dev libdbus-glib-1-dev
+            sudo apt-get install python3-venv  # Necessary on py2.7 circleci image
+            python3 -m venv venv
+            . venv/bin/activate
+            pip install tox
+            pip install codecov
+
+      - run:
+          name: Run tests
+          command: |
+            . venv/bin/activate
+            # If we don't specify the python version then the default
+            # 3.5 version that is part of all images is run which causes
+            # issues.
+            TOX_ENV="$(echo ${PYTHON_VERSION} | sed -E 's/([[:digit:]]).([[:digit:]])+.([[:digit:]])+/py\1\2/')"
+            tox -e "$TOX_ENV"
+            codecov
+
+jobs:
+  py2.7:
+    <<: *shared
+    docker:
+      - image: circleci/python:2.7
+  py3.5:
+    <<: *shared
+    docker:
+      - image: circleci/python:3.5
+  py3.6:
+    <<: *shared
+    docker:
+      - image: circleci/python:3.6
+  py3.7:
+    <<: *shared
+    docker:
+      - image: circleci/python:3.7
+
+workflows:
+  version: 2
+  test:
+    jobs:
+      - py2.7
+      - py3.5
+      - py3.6
+      - py3.7

.github/ISSUE_TEMPLATE.md

@@ -1,12 +1,25 @@
 ## README
+
+**READ BELOW THE FOLD BEFORE REPORTING AN ISSUE**
+
+------
+
 If you're looking for **help** on how to use the library head over to the
 [Raspberry Pi forums](https://www.raspberrypi.org/forums/viewforum.php?f=32&sid=f1a4513e3e137272da39dbb11089e077)
 
 If you're reporting an issue or requesting a feature, read on! Pick one of the
 following templates depending on your issue type.
 
 ------
-Delete above and including this line.
+
+If you're going to report an issue, please pick one of the template below:
+
+* Issue report
+* Feature request
+
+Delete the template you aren't using.
+
+**FINALLY, DELETE ALL THE ABOVE AND THIS LINE.**
 
 
 # Issue Report

.github/PULL_REQUEST_TEMPLATE.md

@@ -19,10 +19,4 @@ other_pr_master     | [link]()
 ## Steps to Test or Reproduce
 Outline the steps to test or reproduce the PR here.
 
-```sh
-git pull --prune
-git checkout <feature_branch>
-bundle; script/server
-```
-
 1. 

.gitignore

@@ -2,6 +2,9 @@
 __pycache__/
 *.py[cod]
 
+# pyenv
+.python-version
+
 # C extensions
 *.so
 
@@ -57,3 +60,6 @@ docs/_build/
 .idea
 
 **/build
+
+# Vim
+*.swp

CHANGELOG.md

@@ -0,0 +1,58 @@
+# 0.3.2 -> 0.3.3
+* Clean up process when start up fails (#196)
+
+# 0.3.1 -> 0.3.2
+* Remove unused imports (`mock`) causing errors (#157)
+
+# 0.3.0 -> 0.3.1
+* Remove `tests` package from distribution
+* Support calling `quit` multiple times without raising exception
+
+# 0.2.5 -> 0.3.0
+
+* Change `set_volume` to work with values between 0-10 instead of
+  millibels
+* Fix `volume` to return actual volume rather than just 1.0
+* Fix `rate` to return actual rate rather than just 1.0
+* Support providing arguments as a `str` which is then split with `shlex.split`,
+  i.e. you don't have to provide a list of shell split args if you don't want to.
+* Support `str` media file path in `OMXPlayer` constructor.
+* Cleanup omxplayer process on exit
+
+
+# 0.2.4 -> 0.2.5
+
+* Correct `omxplayer.__version__` to return 0.2.5 instead of 0.2.3 (in 0.2.4)
+
+# 0.2.3 -> 0.2.4
+
+* New methods:
+  * `aspect_ratio`
+  * `can_raise`
+  * `fullscreen`
+  * `has_track_list`
+  * `height`
+  * `hide_subtitles`
+  * `hide_video`
+  * `metadata`
+  * `next`
+  * `previous`
+  * `rate`
+  * `select_audio`
+  * `select_subtitle`
+  * `set_rate`
+  * `show_subtitles`
+  * `show_video`
+  * `supported_uri_schemes`
+  * `video_pos`
+  * `video_stream_count`
+  * `width`
+* We no longer verify the source exists before playing to allow a broader range
+  of valid inputs
+* Revamped docs, available at http://python-omxplayer-wrapper.readthedocs.io/
+
+## Developer relevant changes
+
+* Added integration tests
+* Refactored tests
+* Unit testing on python 3.5 and 3.6 in travis

CONTRIBUTING.rst

@@ -0,0 +1,76 @@
+Contributing
+============
+
+Rules
+-----
+
+-  **Thou shalt not break the build**.
+-  **Thou shalt not break the tests**.
+-  **Thou shalt write tests for new functionality**.
+-  **Thou shalt rebase onto ``develop`` instead of merging**.
+-  Don't reduce test coverage, ideally improve it.
+-  Add doc comments if your code is to be used by client code.
+
+Thou shalt receive cookies for your welcomed contribution.
+
+Development
+-----------
+
+1. Set up a virtual environment 
+
+   .. code:: console
+
+       $ python3 -m venv .venv
+       $ .venv/bin/activate
+
+2. Install package in editable mode with dependencies
+
+   .. code:: console
+
+       $ pip install ".[test,docs]" -e . 
+
+3. Run unit tests
+
+   .. code:: console
+
+       $ make test              # run under current python version
+
+       $ pip install tox pyenv tox-pyenv  # Install pyenv tox to run under all python versions
+       $ git clone https://github.com/momo-lab/xxenv-latest.git "$(pyenv root)"/plugins/xxenv-latest
+       $ for v in 2.7 3.4 3.5 3.6 3.7; do pyenv la test install "$v"; done
+       $ pyenv versions --base > .python-version
+       $ make test-all          # run under tox for all supported python versions
+
+4. Run integration tests (on Raspberry Pi)
+
+   .. code:: console
+
+       $ make test-integration
+
+
+5. Build docs
+
+   .. code:: console
+
+       $ make doc
+       $ make doc-serve   # run HTTP server to view docs
+
+6. Run examples
+
+   .. code:: console
+
+       $ cd examples
+       $ PYTHONPATH=.. python3 video_file.py
+       $ PYTHONPATH=.. python3 advanced_usage.py
+
+
+On a Raspberry Pi
+~~~~~~~~~~~~~~~~~
+
+There's also an Ansible playbook in ``devenv`` which will set up a
+raspberry pi with ``omxplayer-wrapper`` in develop mode (located at
+``/usr/src/omxplayer-wrapper``) which can be used by running
+``./devenv/deploy.sh``
+
+This will install via symlinks so that you can continue to work on it
+locally but import it from other python packages

Makefile

@@ -1,24 +1,36 @@
-PYTHON2:=python2
-PYTHON3:=python3
+PYTHON2 ?= python2
+PYTHON3 ?= python3
 
-.PHONY: check
-check: test
+.PHONY: init
+init:
+	pip install ".[test,docs]" -e .
 
 .PHONY: test
 test:
+	pytest tests/unit --cov-branch --cov=omxplayer
+
+.PHONY: test-all
+test-all:
 	tox
 
+.PHONY: test-integration
+test-integration:
+	pytest tests/integration/test.py
+
 .PHONY: dist
-dist: test
-	$(PYTHON3) setup.py bdist_wheel --universal
+dist:
+	$(PYTHON3) setup.py sdist bdist_wheel --universal
 
-dist-upload: clean-dist dist
+dist-upload: clean dist
 	twine upload dist/*
 
-clean-dist:
-	rm -rf build
-	rm -rf dist
-
 .PHONY: doc
 doc:
 	$(MAKE) -C docs html
+
+.PHONY: doc-serve
+doc-serve: doc
+	cd docs/build/html && $(PYTHON3) -m http.server
+
+clean:
+	rm -rf dist build $(shell find . -iname '*.egg-info')