From 2aa3e5b28b467e9d9dda67a30cde3ca4ab5ba20b Mon Sep 17 00:00:00 2001 From: Phil Howard Date: Thu, 10 Oct 2019 11:22:34 +0100 Subject: [PATCH] Initial commit from CookieCutter project --- .gitignore | 9 ++ .travis.yml | 28 +++++ CHANGELOG.rst | 9 ++ LICENSE | 202 ++++++++++++++++++++++++++++++ MANIFEST.in | 9 ++ README.rst | 54 ++++++++ mopidy_raspberry_gpio/__init__.py | 37 ++++++ mopidy_raspberry_gpio/ext.conf | 5 + mopidy_raspberry_gpio/frontend.py | 17 +++ setup.cfg | 6 + setup.py | 45 +++++++ tests/__init__.py | 0 tests/test_extension.py | 25 ++++ tox.ini | 26 ++++ 14 files changed, 472 insertions(+) create mode 100644 .gitignore create mode 100644 .travis.yml create mode 100644 CHANGELOG.rst create mode 100644 LICENSE create mode 100644 MANIFEST.in create mode 100644 README.rst create mode 100644 mopidy_raspberry_gpio/__init__.py create mode 100644 mopidy_raspberry_gpio/ext.conf create mode 100644 mopidy_raspberry_gpio/frontend.py create mode 100644 setup.cfg create mode 100644 setup.py create mode 100644 tests/__init__.py create mode 100644 tests/test_extension.py create mode 100644 tox.ini diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3b29847 --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +*.egg-info +*.pyc +.coverage +.pytest_cache/ +.tox/ +MANIFEST +build/ +dist/ +.vscode/ diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..32df99f --- /dev/null +++ b/.travis.yml @@ -0,0 +1,28 @@ +language: python + +python: + - "2.7" + +virtualenv: + system_site_packages: true + +addons: + apt: + sources: + - mopidy-stable + packages: + - mopidy + +env: + - TOX_ENV=py27 + - TOX_ENV=flake8 + - TOX_ENV=check-manifest + +install: + - pip install tox + +script: + - tox -e $TOX_ENV + +after_success: + - if [ $TOX_ENV == 'py27' ]; then pip install coveralls; coveralls; fi diff --git a/CHANGELOG.rst b/CHANGELOG.rst new file mode 100644 index 0000000..45ac0ae --- /dev/null +++ b/CHANGELOG.rst @@ -0,0 +1,9 @@ +********* +Changelog +********* + + +v0.0.1 (UNRELEASED) +======================================== + +- Initial release. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..31fe726 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,9 @@ +include .travis.yml +include CHANGELOG.rst +include LICENSE +include MANIFEST.in +include README.rst +include mopidy_raspberry_gpio/ext.conf +include tox.ini + +recursive-include tests *.py diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..01cc755 --- /dev/null +++ b/README.rst @@ -0,0 +1,54 @@ +**************************** +Mopidy-Raspberry-GPIO +**************************** + +.. image:: https://img.shields.io/pypi/v/Mopidy-Raspberry-GPIO.svg?style=flat + :target: https://pypi.org/project/Mopidy-Raspberry-GPIO/ + :alt: Latest PyPI version + +.. image:: https://img.shields.io/travis/pimoroni/mopidy-raspberry-gpio/master.svg?style=flat + :target: https://travis-ci.org/pimoroni/mopidy-raspberry-gpio + :alt: Travis CI build status + +.. image:: https://img.shields.io/coveralls/pimoroni/mopidy-raspberry-gpio/master.svg?style=flat + :target: https://coveralls.io/r/pimoroni/mopidy-raspberry-gpio + :alt: Test coverage + +Mopidy extension for GPIO input on a Raspberry Pi + + +Installation +============ + +Install by running:: + + pip install Mopidy-Raspberry-GPIO + +Or, if available, install the Debian/Ubuntu package from `apt.mopidy.com +`_. + + +Configuration +============= + +Before starting Mopidy, you must add configuration for +Mopidy-Raspberry-GPIO to your Mopidy configuration file:: + + [raspberry-gpio] + # TODO: Add example of extension config + + +Project resources +================= + +- `Source code `_ +- `Issue tracker `_ +- `Changelog `_ + + +Credits +======= + +- Original author: `Phil Howard `__ +- Current maintainer: `Phil Howard `__ +- `Contributors `_ diff --git a/mopidy_raspberry_gpio/__init__.py b/mopidy_raspberry_gpio/__init__.py new file mode 100644 index 0000000..0a2c58a --- /dev/null +++ b/mopidy_raspberry_gpio/__init__.py @@ -0,0 +1,37 @@ +from __future__ import unicode_literals + +import logging +import os + +from mopidy import config, ext + + +__version__ = "0.0.1" + +# TODO: If you need to log, use loggers named after the current Python module +logger = logging.getLogger(__name__) + + +class Extension(ext.Extension): + + dist_name = "Mopidy-Raspberry-GPIO" + ext_name = "raspberry-gpio" + version = __version__ + + def get_default_config(self): + conf_file = os.path.join(os.path.dirname(__file__), "ext.conf") + return config.read(conf_file) + + def get_config_schema(self): + schema = super(Extension, self).get_config_schema() + # TODO: Comment in and edit, or remove entirely + #schema["username"] = config.String() + #schema["password"] = config.Secret() + return schema + + def setup(self, registry): + # You will typically only implement one of the following things + # in a single extension. + + from .frontend import RaspberryGPIO + registry.add("frontend", RaspberryGPIO) diff --git a/mopidy_raspberry_gpio/ext.conf b/mopidy_raspberry_gpio/ext.conf new file mode 100644 index 0000000..09cbecc --- /dev/null +++ b/mopidy_raspberry_gpio/ext.conf @@ -0,0 +1,5 @@ +[raspberry-gpio] +enabled = true +# bcm1 = play_pause,active_low,30 +# bcm5 = volume_up,active_low,30 +# bcm6 = volume_down,active_low,30 diff --git a/mopidy_raspberry_gpio/frontend.py b/mopidy_raspberry_gpio/frontend.py new file mode 100644 index 0000000..72be2a8 --- /dev/null +++ b/mopidy_raspberry_gpio/frontend.py @@ -0,0 +1,17 @@ +from __future__ import unicode_literals + +import logging +import os + +from mopidy import core + + +import pykka + + +logger = logging.getLogger(__name__) + + +class RaspberryGPIO(pykka.ThreadingActor, core.CoreListener): + def __init__(self, config, core): + pass diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..614c20c --- /dev/null +++ b/setup.cfg @@ -0,0 +1,6 @@ +[flake8] +application-import-names = mopidy_raspberry_gpio,tests +exclude = .git,.tox + +[wheel] +universal = 1 diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..cbbc9b2 --- /dev/null +++ b/setup.py @@ -0,0 +1,45 @@ +from __future__ import unicode_literals + +import re + +from setuptools import find_packages, setup + + +def get_version(filename): + with open(filename) as fh: + metadata = dict(re.findall('__([a-z]+)__ = "([^"]+)"', fh.read())) + return metadata["version"] + + +setup( + name="Mopidy-Raspberry-GPIO", + version=get_version("mopidy_raspberry_gpio/__init__.py"), + url="https://github.com/pimoroni/mopidy-raspberry-gpio", + license="Apache License, Version 2.0", + author="Phil Howard", + author_email="phil@pimoroni.com", + description="Mopidy extension for GPIO input on a Raspberry Pi", + long_description=open("README.rst").read(), + packages=find_packages(exclude=["tests", "tests.*"]), + zip_safe=False, + include_package_data=True, + python_requires="> 2.7, < 3", + install_requires=[ + "setuptools", + "Mopidy >= 2.2", + "Pykka >= 2.0", + ], + entry_points={ + "mopidy.ext": [ + "raspberry-gpio = mopidy_raspberry_gpio:Extension", + ] + }, + classifiers=[ + "Environment :: No Input/Output (Daemon)", + "Intended Audience :: End Users/Desktop", + "License :: OSI Approved :: Apache Software License", + "Operating System :: OS Independent", + "Programming Language :: Python :: 2.7", + "Topic :: Multimedia :: Sound/Audio :: Players", + ], +) diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tests/test_extension.py b/tests/test_extension.py new file mode 100644 index 0000000..e98754c --- /dev/null +++ b/tests/test_extension.py @@ -0,0 +1,25 @@ +from __future__ import unicode_literals + +from mopidy_raspberry_gpio import Extension, frontend as frontend_lib + + +def test_get_default_config(): + ext = Extension() + + config = ext.get_default_config() + + assert "[raspberry-gpio]" in config + assert "enabled = true" in config + + +def test_get_config_schema(): + ext = Extension() + + schema = ext.get_config_schema() + + # TODO Test the content of your config schema + #assert "username" in schema + #assert "password" in schema + + +# TODO Write more tests diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..291aed4 --- /dev/null +++ b/tox.ini @@ -0,0 +1,26 @@ +[tox] +envlist = py27, flake8, check-manifest + +[testenv] +sitepackages = true +deps = + mock + pytest + pytest-cov + pytest-xdist +commands = + pytest \ + --basetemp={envtmpdir} \ + --cov=mopidy_raspberry_gpio --cov-report=term-missing \ + {posargs} + +[testenv:flake8] +deps = + flake8 + flake8-import-order +skip_install = true +commands = python -m flake8 + +[testenv:check-manifest] +deps = check-manifest +commands = check-manifest