Merge pull request #21 from takeyamayuki/develop

PyPI support

Author: takeyamayuki

.gitignore

@@ -12,9 +12,8 @@ dist-win/
 dist-linux/
 app-s.spec
 
-# py2exe
 .eggs/
-setup.py
+*.egg-info/
 
 # pip
 site-packages

MANIFEST.in

@@ -0,0 +1 @@
+include requirements.txt

README.md

@@ -37,22 +37,17 @@
 - Just download from the latest release(windows, mac only).  
 
 # Installation
-## 📁 Run as executable file 
+## 📁 Executable file 
 Download the zip file that matches your environment from the [latest release](https://github.com/takeyamayuki/NonMouse/releases). 
 
 OR
-## 🐍 Run as python
+## 🐍 PyPI
 Run the following script.
 
 ```sh
-$ git clone https://github.com/takeyamayuki/NonMouse
-$ cd NonMouse
-$ pip install -r requirements.txt
+$ pip install nonmouse
 ```
-If you have trouble installing mediapipe, please visit the [official website](https://google.github.io/mediapipe/getting_started/install.html).  
-
-> **Note**   
-> For mac, you need to add the location where you want to run it, such as Terminal or VScode, to the Security and Privacy Accessibility and Cammera section in System Preferences.
+(If you have trouble installing mediapipe, please visit the [official website](https://google.github.io/mediapipe/getting_started/install.html).)
 
 # Usage
 ## 1. Install a camera
@@ -91,15 +86,14 @@ The following three ways of placing the device are assumed.
    OR
 -  Run the following script from the continuation of the installation.
 
-   For windows, linux(global hotkey function does not work in linux.)
+   For windows and linux(global hotkey function does not work in linux.)
    ```sh
-   $ python3 -m nonmouse
+   $ nonmouse
    ```
 
    For MacOS, you need execute permission.
    ```sh
-   $ sudo /path/to/python3 -m nonmouse
-   # When you invoke python with sudo, the system python is invoked, so you must specify the python you want to run yourself.
+   $ sudo nonmouse
    ```
 
 ## 3. Settings
@@ -163,13 +157,15 @@ Run the following scripts for each OS.
    ...
    Location: c:\users\namik\appdata\local\programs\python\python37\lib\site_packages
    ...
-   #Copy and paste into the datas in app-win.spec
+   #Copy and paste into the datas in win.spec
    $ pyinstaller config/win.spec
    ... ````
 - mac
 
    Create a venv environment and perform `pip install`, because the directory specified in `datas` is for an assumed venv environment. 
    ```sh 
+   $ git clone https://github.com/takeyamayuki/NonMouse.git
+   $ cd NonMouse
    $ python3 -m venv venv
    $ . venv/bin/activate
    (venv)$ pip install -r requirements.txt

config/mac.spec

@@ -4,11 +4,11 @@
 block_cipher = None
 
 
-a = Analysis(['app.py'],
+a = Analysis(['../nonmouse/__main__.py'],
              pathex=['/Users/yukitakeyama/Documents/Python/NonMouse2g'],    # 各々の環境に合わせてPATHを変更してください
-             binaries=[('/System/Library/Frameworks/Tcl.framework/Versions/8.5/tclsh8.5', 'tcl')],
-             datas=[('venv/lib/python3.9/site-packages/mediapipe/modules', 'mediapipe/modules'),], 
-             hiddenimports=['pynput', 'pywinauto', 'tkinter', 'tkinter.filedialog prog', 'pkg_resources.py2_warn', 'pkg_resources.markers'],
+             binaries=[],
+             datas=[('../venv/lib/python3.9/site-packages/mediapipe/modules', 'mediapipe/modules'),], 
+            #  hiddenimports=['pynput', 'pywinauto', 'tkinter', 'tkinter.filedialog prog', 'pkg_resources.py2_warn', 'pkg_resources.markers'],
              hookspath=[],
              hooksconfig={},
              runtime_hooks=[],
@@ -37,4 +37,4 @@ exe = EXE(pyz,
           disable_windowed_traceback=False,
           target_arch=None,
           codesign_identity=None,
-          entitlements_file=None , icon='icon.ico')
+          entitlements_file=None , icon='../images/icon.ico')

config/win.spec

@@ -4,7 +4,7 @@
 block_cipher = None
 
 
-a = Analysis(['app.py'],
+a = Analysis(['..\\nonmouse\\__main__.py'],
              pathex=['C:\\Users\\namik\\Documents\\NonMouse\\NonMouse'],    #それぞれの環境に応じて、変更してください
              binaries=[],
              datas=[('C:\\users\\namik\\appdata\\local\\programs\\python\\python37\\lib\\site-packages\\mediapipe\\modules', 'mediapipe\\modules'),],
@@ -37,4 +37,4 @@ exe = EXE(pyz,
           disable_windowed_traceback=False,
           target_arch=None,
           codesign_identity=None,
-          entitlements_file=None , icon='icon.ico')
+          entitlements_file=None , icon='..\\images\\icon.ico')

fig/icon.ico renamed to images/icon.ico

@@ -1,2 +1,16 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
+from nonmouse import *
+import os, glob
+
+__copyright__    = 'Copyright (C) 2023 Yuki TAKEYAMA'
+__version__      = '2.7.0'
+__license__      = 'Apache-2.0'
+__author__       = 'Yuki TAKEYAMA'
+__author_email__ = '[email protected]'
+__url__          = 'http://github.com/takeyamayuki/NonMouse'
+
+__all__ = [
+    os.path.split(os.path.splitext(file)[0])[1]
+    for file in glob.glob(os.path.join(os.path.dirname(__file__), '[a-zA-Z0-9]*.py'))
+]

nonmouse/__init__.py

@@ -26,7 +26,7 @@
 elif pf == 'Darwin':
     hotkey = 'Command'
 elif pf == 'Linux':
-    hotkey = ''              # hotkeyはLinuxでは無効
+    hotkey = 'XXX'              # hotkeyはLinuxでは無効
 
 
 def main():

nonmouse/__main__.py

@@ -0,0 +1,19 @@
+from setuptools import setup, find_packages
+
+def _requires_from_file(filename):
+    return open(filename).read().splitlines()
+
+
+setup(
+    name='nonmouse',
+    version='2.7.0',
+    packages=find_packages(),
+    description='a webcam-based virtual gesture mouse that is easy to use with hands on the desk',
+    author='Yuki TAKEYAMA',
+    author_email='[email protected]',
+    url='https://github.com/takeyamayuki/NonMouse',
+    license='Apache-2.0',
+    install_requires=_requires_from_file('requirements.txt'),
+    entry_points={'console_scripts': ['nonmouse=nonmouse.__main__:main',]},
+    python_requires='>=3.6',
+)