Merge lp:~maphew/leo-editor/pypi-packaging into lp:leo-editor

[Matt Wilkie]

See commit log for details.

The "register-leo.leos" leo script is the least tested part and should be reviewed most closely. If it works widely, it obviates the need for "create-leobat.bat ... register" to register file type, and consolidates setting the filetype and Explorer icon into a single package.

[Edward K. Ream (edreamleo)]

On Fri, May 10, 2013 at 3:55 AM, Matt Wilkie <email address hidden> wrote:

> Matt Wilkie has proposed merging lp:~maphew/leo-editor/pypi-packaging into
> lp:leo-editor.
>

Go ahead. The script will be a starting point. Not sure what I think
about .leos (Leo script) file extension: it's just a .py file.

Edward

[Jake Peck (gatesphere)]

On 5/10/2013 7:25 AM, Edward K. Ream wrote:
> On Fri, May 10, 2013 at 3:55 AM, Matt Wilkie <email address hidden> wrote:
>
>> Matt Wilkie has proposed merging lp:~maphew/leo-editor/pypi-packaging into
>> lp:leo-editor.
>>
> Go ahead. The script will be a starting point. Not sure what I think
> about .leos (Leo script) file extension: it's just a .py file.
>
> Edward
>
I agree, w/r/t the .leos extension - just do .py, and perhaps have a
guard in the `if __name__ == '__main__':` bit... perhaps check for the
existence of g.app? If it's not found, print a message stating that
"This script needs to be run from Leo!" and exit.

-->Jake

[Matt Wilkie (maphew)]

> Go ahead.

ok, thanks.

> The script will be a starting point. Not sure what I think
> about .leos (Leo script) file extension: it's just a .py file.

yeah, it's a .py file, but you can't use it unless you're inside Leo. I
just wanted an easy way to tell the difference between a Leo script and
regular python module without having to inspect it.

-matt

=== added file 'build-leo.bat'
--- build-leo.bat	1970-01-01 00:00:00 +0000
+++ build-leo.bat	2013-05-10 08:54:30 +0000
@@ -0,0 +1,6 @@
+#@+leo-ver=5-thin
+#@+node:maphew.20130505160115.1636: * @file leo-editor/build-leo.bat
+python setup.py sdist
+python setup.py bdist_wininst --user-access-control=auto --bitmap leo\Icons\SplashScreen-installer.bmp
+start dist
+#@-leo
 
=== added file 'create-leobat.bat'
--- create-leobat.bat	1970-01-01 00:00:00 +0000
+++ create-leobat.bat	2013-05-10 08:54:30 +0000
@@ -0,0 +1,68 @@
+@echo off
+:: A batch file which generates other batch files to run the Leo Editor,
+:: adapted for the local machine. Optionally, it will also set the Windows
+:: filetype and association so .leo files can be opened from Explorer.
+::
+:: It needs to live in the same folder as "launchLeo.py"
+::
+:: Open Source X/MIT License
+:: initial version * 2012-Dec-13 * matt wilkie <[e-mail]>
+
+if "%1"=="" goto :Usage
+
+call :pyCheck %1
+call :main %1
+if "%2"=="register" call :register %1
+goto :eof
+
+:main
+  :: %1 is the path to folder containing python .exe's
+  set pyexe=%~dp1python.exe
+  set pywexe=%~dp1pythonw.exe
+  echo.
+  echo. Generating...
+  echo.
+  echo. Leo.bat  - run leo in Windows mode
+  echo. Leoc.bat - run leo and keep console window open
+  echo.  
+  echo. These can be placed anywhere in PATH.
+  echo.
+  echo @"%pyexe%" "%~dp0launchLeo.py" %%* > leoc.bat
+  echo @start /b "Leo" "%pywexe%" "%~dp0launchLeo.py" %%* > leo.bat
+  goto :eof
+
+:register
+  :: perms check courtesy of http://stackoverflow.com/questions/4051883
+  :: batch-script-how-to-check-for-admin-rights
+  net session >nul 2>&1
+  if %errorlevel% == 0 (    
+    echo.
+    echo. Setting .leo filetype and registering association with Windows
+    echo.
+    assoc .leo=Leo.File
+    ftype Leo.File=%pywexe% "%~dp0launchLeo.py" "%%1" %%*
+   ) else (
+    echo. Error: Can't set filetype and register association.
+    echo. Please run from elevated shell to do that.
+    echo.
+    )
+  goto :eof
+
+:pyCheck
+  if not exist "%1" goto :Usage
+  goto :eof
+
+:usage
+  echo.
+  echo. -=[%~nx0]=-
+  echo.
+  echo. Create batch files to launch Leo Editor that can be 
+  echo. placed and run from anywhere on this machine.
+  echo.
+  echo. and optionally register filetype with windows
+  echo.
+  echo. Usage:  
+  echo.       %~n0 "c:\path\to\python.exe"
+  echo.       %~n0 "c:\path\to\python.exe" register
+  echo.  
+  goto :eof
 
=== added file 'leo/Icons/SplashScreen-installer.bmp'
 Binary files leo/Icons/SplashScreen-installer.bmp	1970-01-01 00:00:00 +0000 and leo/Icons/SplashScreen-installer.bmp	2013-05-10 08:54:30 +0000 differ
=== added file 'leo/Icons/SplashScreen.xcf'
 Binary files leo/Icons/SplashScreen.xcf	1970-01-01 00:00:00 +0000 and leo/Icons/SplashScreen.xcf	2013-05-10 08:54:30 +0000 differ
=== modified file 'leo/config/leoSettings.leo'
--- leo/config/leoSettings.leo	2013-05-04 12:33:40 +0000
+++ leo/config/leoSettings.leo	2013-05-10 08:54:30 +0000
@@ -4464,7 +4464,7 @@
 
 # Alphabetical list of all Leo plugins.
 
-# active_path.py
+active_path.py
 # add_directives.py
 # at_folder.py
 # at_produce.py
 
=== added file 'register-leo.leos'
--- register-leo.leos	1970-01-01 00:00:00 +0000
+++ register-leo.leos	2013-05-10 08:54:30 +0000
@@ -0,0 +1,83 @@
+#@+leo-ver=5-thin
+#@+node:maphew.20130501121440.1885: * @file register-leo.leos
+#@@language python
+#@@tabwidth -4
+#@+others
+#@+node:maphew.20130510011223.1645: ** docstring
+'''Tell Windows how to handle .leo files, enables double clicking on them to open.
+
+To run: in Leo make this the active node and press [Ctrl-B] (execute-script)
+        
+Requires elevated User Account Control (UAC) privileges.
+See http://superuser.com/questions/88491/force-cmd-exe-to-run-as-admin/
+'''
+#@+node:maphew.20130509185752.1607: ** register_leo
+def register_leo(pyexe, launchLeo, icon):
+    '''Create registry key for Leo file type, set default icon, and launch command
+    
+    Resources:
+        http://stackoverflow.com/questions/2331690/how-to-set-a-icon-file-while-creating-file
+        http://stackoverflow.com/questions/771689/how-can-i-set-an-icon-for-my-own-file-extension
+    '''    
+    g.es("\nAttempting to register leo filetype with Windows...")
+    
+    if g.os_path_exists(icon):
+        g.es("Found:", icon)
+        
+        leoKey = CreateKey(HKEY_CLASSES_ROOT, "Leo.File")
+        iconKey = CreateKey(leoKey, "DefaultIcon")
+        shellKey = CreateKey(leoKey, "Shell")
+        openKey = CreateKey(shellKey, "Open")
+        cmdKey = CreateKey(openKey, "Command")
+
+        SetValue(leoKey, None, REG_SZ, "Leo Editor File")
+        SetValue(iconKey, None, REG_SZ, icon)
+        SetValueEx(cmdKey, None, None, REG_EXPAND_SZ, '"{0}" "{1}" "%1" %*'.format(pywexe, launchLeo))
+        
+        for k in (leoKey, iconKey, shellKey, openKey, cmdKey):
+            CloseKey(k)
+
+        g.es("Registered!")
+    else:
+        g.es("LeoDoc.ico not in expected location, can't continue.")  
+#@+node:maphew.20130510011223.1646: *3* sample registry outcome
+'''This is what the resulting registry key should look like, once exported from
+regedit. The translated hex code is:
+    
+    "d:\Python27\python.exe" "C:\Users\Matt\Dropbox\apps\leo-editor\launchLeo.py" "%1" %*
+    
+'''
+#@+at
+# Windows Registry Editor Version 5.00
+# 
+# [HKEY_CLASSES_ROOT\Leo.File]
+# @="Leo Editor File"
+# 
+# [HKEY_CLASSES_ROOT\Leo.File\DefaultIcon]
+# @="C:\\Users\\Matt\\Dropbox\\apps\\leo-editor\\leo\\Icons\\LeoDoc.ico"
+# 
+# [HKEY_CLASSES_ROOT\Leo.File\Shell]
+# 
+# [HKEY_CLASSES_ROOT\Leo.File\Shell\Open]
+# 
+# [HKEY_CLASSES_ROOT\Leo.File\Shell\Open\Command]
+# @=hex(2):22,00,64,00,3a,00,5c,00,50,00,79,00,74,00,68,00,6f,00,6e,00,32,00,37,\
+#   00,5c,00,70,00,79,00,74,00,68,00,6f,00,6e,00,2e,00,65,00,78,00,65,00,22,00,\
+#   20,00,22,00,43,00,3a,00,5c,00,55,00,73,00,65,00,72,00,73,00,5c,00,4d,00,61,\
+#   00,74,00,74,00,5c,00,44,00,72,00,6f,00,70,00,62,00,6f,00,78,00,5c,00,61,00,\
+#   70,00,70,00,73,00,5c,00,6c,00,65,00,6f,00,2d,00,65,00,64,00,69,00,74,00,6f,\
+#   00,72,00,5c,00,6c,00,61,00,75,00,6e,00,63,00,68,00,4c,00,65,00,6f,00,2e,00,\
+#   70,00,79,00,22,00,20,00,22,00,25,00,31,00,22,00,20,00,25,00,2a,00,00,00
+#@-others
+from _winreg import *
+
+pyexe = g.sys.executable
+pywexe = pyexe.replace('python.exe', 'pythonw.exe')
+launchLeo = g.os_path_finalize_join(g.computeLeoDir(), '../launchLeo.py')
+icon = "%s\Icons\LeoDoc.ico" % g.computeLeoDir()
+
+g.es(pywexe)
+g.es(launchLeo)
+
+register_leo(pyexe, launchLeo, icon)
+#@-leo
 
=== modified file 'setup.py'
--- setup.py	2013-04-18 19:54:01 +0000
+++ setup.py	2013-05-10 08:54:30 +0000
@@ -19,6 +19,21 @@
 from distutils.command.install_data import install_data
 from distutils.command.install import INSTALL_SCHEMES
 import os,fnmatch
+#@+node:maphew.20130503222911.1635: ** Get description
+try:
+    long_description = open('README.TXT', 'rt').read()
+except IOError:
+    long_description = """
+Leo is an outline-oriented IDE written in 100% pure Python.
+Leo features a multi-window outlining editor, Python colorizing,
+powerful outline commands and many other things, including 
+unlimited Undo/Redo and an integrated Python shell(IDLE) window.
+Leo requires Python 2.6 or above.  Leo works with Python 3.x.
+Requires PyQt and SIP preinstalled.
+    """
+#@+node:maphew.20130508020338.1645: ** Get version
+import leo
+version = '{0}-build-{1}'.format(leo.core.leoVersion.version, leo.core.leoVersion.build)
 #@+node:ville.20090213231648.3: ** fullsplit
 import sys
 
@@ -91,7 +106,6 @@
         file_info[0] = '\\PURELIB\\%s' % file_info[0]
 #@-others
 
-
 # Note than only *.ui matches now - add asterisks as needed/valid
 datapats = ['.tix', '.GIF', '.dbm', '.conf', '.TXT', '.xml', '.gif', '*.leo', '.def', '.svg', '*.ini', '.six', '.bat', '.cat', '.pro', '.sh', '.xsl', '.bmp', '.js', '*.ui', '.rix', '.pmsp',  '.pyd', '.png', '.alg', '.php',  '.css', '.ico', '*.txt', '.html',  '.iix',  '.w']
 #print data_files
@@ -100,28 +114,21 @@
 # https://testpypi.python.org/pypi?name=leo-editor&version=4.10-final&:action=submit_form
 setup(
     name = 'leo-editor',
-    version = "4.10-final",
+    version = version,
     author = "Edward K. Ream",
     author_email = '[e-mail]',
-    #maintainer = '',
-    #maintainer_email = '',
+    maintainer = 'Matt Wilkie',
+    maintainer_email = '[e-mail]',
     url = 'http://leoeditor.com',
     license = 'MIT License',
     description = "Leonine Editor with Outlines",
-    long_description = """
-Leo is an outline-oriented IDE written in 100% pure Python.
-Leo features a multi-window outlining editor, Python colorizing,
-powerful outline commands and many other things, including 
-unlimited Undo/Redo and an integrated Python shell(IDLE) window.
-Leo requires Python 2.6 or above.  Leo works with Python 3.x.
-Requires PyQt and SIP preinstalled.
-    """,
+    long_description = long_description,
     #keywords = [],
     platforms = ['linux','windows'],
-    download_url = 'http://sourceforge.net/projects/leo/files/Leo/4.10%20final/Leo-4.10-final.zip/download',
+    download_url = 'http://sourceforge.net/projects/leo/files/Leo/',
     #bugtrack_url = 'https://bugs.launchpad.net/leo-editor',    #only py3?
 
-    # only include dependencies which can be installed by pip
+    # only include dependencies which can be installed by pip (so not PyQt or SIP)
     requires = ['docutils'],
 
     #provides = [],