diff --git a/.coveragerc b/.coveragerc new file mode 100644 index 0000000..fcae781 --- /dev/null +++ b/.coveragerc @@ -0,0 +1,15 @@ +[run] +source = + cvpubsubs + tests +branch = True +omit = + cvpubsubs/cli.py + +[report] +exclude_lines = + no cov + no qa + noqa + pragma: no cover + if __name__ == .__main__.: diff --git a/.gitignore b/.gitignore index 71d977d..3c71423 100644 --- a/.gitignore +++ b/.gitignore @@ -106,3 +106,4 @@ venv.bak/ .mypy_cache/ .idea/ +.pytest_cache/ diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..8a03bef --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,178 @@ +Copyright 2018 SimLeek + + 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 diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..2acd40f --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,21 @@ +Copyright (c) 2018 SimLeek + +MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..4b1e582 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,6 @@ +include README.md +include README.rst +include README.txt +include LICENSE-APACHE +include LICENSE-MIT +include LICENSE.md diff --git a/README.md b/README.md index f539f9c..0152002 100644 --- a/README.md +++ b/README.md @@ -1 +1,25 @@ -A threaded PubSub OpenCV interfaceREADME.md. Webcam and video feeds to multiple windows is supported. \ No newline at end of file +CVPubSubs +========= + +A threaded PubSub OpenCV interfaceREADME.md. Webcam and video feeds to multiple windows is supported. + +Installation +------------ + +CVPubSubs is distributed on `PyPI `_ as a universal +wheel and is available on Linux/macOS and Windows and supports +Python 2.7/3.5+ and PyPy. + + $ pip install CVPubSubs + +License +------- + +CVPubSubs is distributed under the terms of both + +- `MIT License `_ +- `Apache License, Version 2.0 `_ + +at your option. + + diff --git a/__init__.py b/__init__.py index 05bfaf5..b826e76 100644 --- a/__init__.py +++ b/__init__.py @@ -1,2 +1,2 @@ # redirection, so we can use subtree like pip -from .cv_pubsubs import webcam_pub, window_sub +from cvpubsubs import webcam_pub, window_sub diff --git a/cv_pubsubs/__init__.py b/cv_pubsubs/__init__.py deleted file mode 100644 index 02df0f8..0000000 --- a/cv_pubsubs/__init__.py +++ /dev/null @@ -1 +0,0 @@ -from . import window_sub, webcam_pub diff --git a/cvpubsubs/__init__.py b/cvpubsubs/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/cv_pubsubs/listen_default.py b/cvpubsubs/listen_default.py similarity index 100% rename from cv_pubsubs/listen_default.py rename to cvpubsubs/listen_default.py diff --git a/cv_pubsubs/webcam_pub/__init__.py b/cvpubsubs/webcam_pub/__init__.py similarity index 100% rename from cv_pubsubs/webcam_pub/__init__.py rename to cvpubsubs/webcam_pub/__init__.py diff --git a/cv_pubsubs/webcam_pub/camctrl.py b/cvpubsubs/webcam_pub/camctrl.py similarity index 100% rename from cv_pubsubs/webcam_pub/camctrl.py rename to cvpubsubs/webcam_pub/camctrl.py diff --git a/cv_pubsubs/webcam_pub/frame_handler.py b/cvpubsubs/webcam_pub/frame_handler.py similarity index 96% rename from cv_pubsubs/webcam_pub/frame_handler.py rename to cvpubsubs/webcam_pub/frame_handler.py index a0a3cbb..89069fa 100644 --- a/cv_pubsubs/webcam_pub/frame_handler.py +++ b/cvpubsubs/webcam_pub/frame_handler.py @@ -3,7 +3,7 @@ import threading import numpy as np import pubsub -from cv_pubsubs.listen_default import listen_default +from cvpubsubs.listen_default import listen_default from .pub_cam import pub_cam_thread if False: diff --git a/cv_pubsubs/webcam_pub/get_cam_ids.py b/cvpubsubs/webcam_pub/get_cam_ids.py similarity index 100% rename from cv_pubsubs/webcam_pub/get_cam_ids.py rename to cvpubsubs/webcam_pub/get_cam_ids.py diff --git a/cv_pubsubs/webcam_pub/pub_cam.py b/cvpubsubs/webcam_pub/pub_cam.py similarity index 98% rename from cv_pubsubs/webcam_pub/pub_cam.py rename to cvpubsubs/webcam_pub/pub_cam.py index 91ce302..59dccd5 100644 --- a/cv_pubsubs/webcam_pub/pub_cam.py +++ b/cvpubsubs/webcam_pub/pub_cam.py @@ -5,7 +5,7 @@ import cv2 import numpy as np import pubsub -from cv_pubsubs.listen_default import listen_default +from cvpubsubs.listen_default import listen_default if False: from typing import Union, Tuple diff --git a/cv_pubsubs/window_sub/__init__.py b/cvpubsubs/window_sub/__init__.py similarity index 100% rename from cv_pubsubs/window_sub/__init__.py rename to cvpubsubs/window_sub/__init__.py diff --git a/cv_pubsubs/window_sub/cv_window_sub.py b/cvpubsubs/window_sub/cv_window_sub.py similarity index 100% rename from cv_pubsubs/window_sub/cv_window_sub.py rename to cvpubsubs/window_sub/cv_window_sub.py diff --git a/cv_pubsubs/window_sub/winctrl.py b/cvpubsubs/window_sub/winctrl.py similarity index 100% rename from cv_pubsubs/window_sub/winctrl.py rename to cvpubsubs/window_sub/winctrl.py diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..c5cab61 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,17 @@ +[metadata] +name = 'CVPubSubs' +version = '0.0.2' +description = 'Simple tool for working with multiple streams from OpenCV.' +author = 'SimLeek' +author_email = 'josh.miklos@gmail.com' +license = 'MIT/Apache-2.0' +url = 'https://github.com/_/CVPubSubs' + +[requires] +python_version = ['2.7', '3.5', '3.6', 'pypy', 'pypy3'] + +[build-system] +requires = ['setuptools', 'wheel'] + +[tool.hatch.commands] +prerelease = 'hatch build' diff --git a/requirements.txt b/requirements.txt index 3d37beb..08f0fc3 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,2 @@ -opencv-python pubsub -numpy \ No newline at end of file +opencv-python \ No newline at end of file diff --git a/setup.py b/setup.py index 5cd3bfe..9e82fc6 100644 --- a/setup.py +++ b/setup.py @@ -1,23 +1,52 @@ -from distutils.core import setup -from setuptools import find_packages +from io import open + +from setuptools import find_packages, setup + +with open('cvpubsubs/__init__.py', 'r') as f: + for line in f: + if line.startswith('__version__'): + version = line.strip().split('=')[1].strip(' \'"') + break + else: + version = '0.0.1' + +with open('README.md', 'r', encoding='utf-8') as f: + readme = f.read() + +REQUIRES = [] setup( - name= 'cv_pubsubs', - version='1.0.0', - packages = find_packages(), - description='Pubsub interface for Python OpenCV', - author='Josh Miklos', - author_email='simulatorleek@gmail.com', - url='https://github.com/SimLeek/cv_pubsubs', - download_url='https://github.com/SimLeek/cv_pubsubs/archive/0.1.tar.gz', - keywords=['OpenCV', 'PubSub'], - license='MIT', + name='CVPubSubs', + version=version, + description='', + long_description=readme, + author='SimLeek', + author_email='josh.miklos@gmail.com', + maintainer='SimLeek', + maintainer_email='josh.miklos@gmail.com', + url='https://github.com/_/CVPubSubs', + license='MIT/Apache-2.0', + + keywords=[ + '', + ], + classifiers=[ - 'Development Status :: 3 - Alpha', + 'Development Status :: 4 - Beta', + 'Intended Audience :: Developers', 'License :: OSI Approved :: MIT License', - 'Programming Language :: Python :: 3', - 'Programming Language :: Python :: 3.6', - 'Programming Language :: Python :: 2', + 'License :: OSI Approved :: Apache Software License', + 'Natural Language :: English', + 'Operating System :: OS Independent', 'Programming Language :: Python :: 2.7', - ] -) \ No newline at end of file + 'Programming Language :: Python :: 3.5', + 'Programming Language :: Python :: 3.6', + 'Programming Language :: Python :: Implementation :: CPython', + 'Programming Language :: Python :: Implementation :: PyPy', + ], + + install_requires=REQUIRES, + tests_require=['coverage', 'pytest'], + + packages=find_packages(), +) diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tests_interactive/test_pub_cam.py b/tests/test_pub_cam.py similarity index 93% rename from tests_interactive/test_pub_cam.py rename to tests/test_pub_cam.py index 4da4d45..e2f6e9f 100644 --- a/tests_interactive/test_pub_cam.py +++ b/tests/test_pub_cam.py @@ -1,4 +1,4 @@ -import cv_pubsubs.webcam_pub as w +import cvpubsubs.webcam_pub as w import unittest as ut diff --git a/tests_interactive/test_sub_win.py b/tests/test_sub_win.py similarity index 93% rename from tests_interactive/test_sub_win.py rename to tests/test_sub_win.py index 089e1ad..a54a5ba 100644 --- a/tests_interactive/test_sub_win.py +++ b/tests/test_sub_win.py @@ -3,9 +3,9 @@ import unittest as ut import pubsub -import cv_pubsubs.webcam_pub as w -from cv_pubsubs.listen_default import listen_default -from cv_pubsubs.window_sub import SubscriberWindows +import cvpubsubs.webcam_pub as w +from cvpubsubs.listen_default import listen_default +from cvpubsubs.window_sub import SubscriberWindows def print_keys_thread(): diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..e25dc9a --- /dev/null +++ b/tox.ini @@ -0,0 +1,18 @@ +[tox] +envlist = + py27, + py35, + py36, + pypy, + pypy3, + +[testenv] +passenv = * +deps = + coverage + pytest +commands = + python setup.py --quiet clean develop + coverage run --parallel-mode -m pytest + coverage combine --append + coverage report -m