Added option to create shortcut in windows 'Send to'

Author: m-haisham

.gitignore

@@ -243,4 +243,7 @@ dmypy.json
 
 # End of https://www.toptal.com/developers/gitignore/api/python,pycharm
 
-*.xml
+*.xml
+
+# specific files
+test.py

README.md

@@ -18,24 +18,53 @@ pip install qrshare
 
 ### Send to
 
+> Windows only
+
+Creating a shortcut in `shell:sendto` provides for easier use of convenience
+
+#### commandline
+
+```bash
+qrshare config --sendto
+```
+
+#### manually
+
 Press `Windows` + `r` and enter `shell:sendto`
 
-> C:\Users\(user)\AppData\Roaming\Microsoft\Windows\SendTo
+> %USERPROFILE%\AppData\Roaming\Microsoft\Windows\SendTo
 
-Create shortcut with command `qrshare` in folder
+Create shortcut with command `qrshare serve` in folder
 
 now option qrshare should appear when you right click to a file
 
 ### Commandline
 
+> `qrshare --help`
+
 ```bash
-qrshare --help
+Usage: __main__.py [OPTIONS] COMMAND [ARGS]...
+
+Options:
+  --help  Show this message and exit.
+
+Commands:
+  config  change user configurations
+  serve   serve given list paths as per given options
 ```
 
+> `qrshare config --help`
+
 ```bash
-Usage: __main__.py [OPTIONS] PATHS...
+Options:
+  --sendto  reset windows 'Send To' shortcut
+  --help    Show this message and exit.
+```
+
+> `qrshare serve --help`
 
-Options:****
+```bash
+Options:
   -p, --password TEXT  when provided every device require authentication
   --port INTEGER       waitress server port
   --help               Show this message and exit.

qrshare/__init__.py

@@ -1,4 +1,5 @@
 from .auth import Authentication
 from .app import App
+from .shortcut import create_shortcut
 
 __version__ = '0.3.3'

qrshare/__main__.py

@@ -2,14 +2,22 @@
 
 import click
 
-from qrshare import App
+from qrshare import App, create_shortcut
 
 
-@click.command()
+@click.group()
+def cli():
+    pass
+
+
+@cli.command()
 @click.argument('paths', nargs=-1, required=True)
 @click.option('-p', '--password', type=str, help='when provided every device require authentication')
 @click.option('--port', default=4000, type=int, help='waitress server port')
 def serve(paths, password, port):
+    """
+    serve given list paths as per given options
+    """
     try:
         app = App([Path(path).resolve() for path in paths], password, port)
 
@@ -24,5 +32,25 @@ def serve(paths, password, port):
         input('Press enter to exit')
 
 
+@cli.command()
+@click.option('--sendto', is_flag=True, help='reset windows \'Send To\' shortcut')
+def config(sendto):
+    """
+    change user configurations
+    """
+    if sendto:
+        # windows send to path
+        path = Path.home() / Path(r'AppData\Roaming\Microsoft\Windows\SendTo')
+
+        print(f'Creating shortcut with command \'qrshare\' in {path}...', end=' ')
+
+        try:
+            create_shortcut(path, 'qrshare', 'serve')
+        except Exception as e:
+            print(e)
+        else:
+            print('done')
+
+
 if __name__ == '__main__':
-    serve()
+    cli()

qrshare/shortcut.py

@@ -0,0 +1,46 @@
+import subprocess
+from pathlib import Path
+import platform
+
+base_batch_script = r"""
+@echo off
+
+set SCRIPT="%TEMP%\%RANDOM%-%RANDOM%-%RANDOM%-%RANDOM%.vbs"
+
+echo Set oWS = WScript.CreateObject("WScript.Shell") > %SCRIPT%
+echo sLinkFile = "{dest}\{command}.lnk" >> %SCRIPT%
+echo Set oLink = oWS.CreateShortcut(sLinkFile) >> %SCRIPT%
+echo oLink.TargetPath = "{command}" >> %SCRIPT%
+echo oLink.Arguments = "{args}" >> %SCRIPT%
+echo oLink.Save >> %SCRIPT%
+
+cscript /nologo %SCRIPT%
+del %SCRIPT%
+"""
+
+
+def create_shortcut(dest: Path, command: str, args: str = ''):
+    """
+    A minimal function that creates a shortcut at the given destination
+
+    :supports: Windows
+
+    :param dest: shortcut destination directory
+    :param command: shortcut command, maybe a file or callable command
+    :param args: commandline arguments
+    :return: None
+    """
+    if platform.system() == 'Windows':
+        script = base_batch_script.format(dest=str(dest), command=command, args=args)
+
+        # create temp bat file
+        script_file = Path.home() / '.qrshare_shortcut_script.bat'
+        with script_file.open('w') as f:
+            f.write(script)
+
+        subprocess.run(str(script_file), stdout=subprocess.PIPE)
+
+        # delete temp batch file
+        script_file.unlink()
+    else:
+        raise Exception(f'{platform.system()} is not supported')

setup.py

@@ -18,7 +18,7 @@
     long_description_content_type='text/markdown',
 
     entry_points={
-        "console_scripts": ["qrshare=qrshare.__main__:serve"]
+        "console_scripts": ["qrshare=qrshare.__main__:cli"]
     },
     install_requires=requirements,
     package_data={