create v1.8 package, add help etc.

Author: hustlei

Pipfile

@@ -10,7 +10,7 @@ pycodestyle = "*"
 yapf = "*"
 pytest = "*"
 pytest-qt = "*"
-pyqt5-tools = "*" #"<5.14.1.3.0.3"
+pyqt5-tools = "<5.14.1.3.0.3"
 
 [packages]
 requests = ">2.0"

Pipfile.bak

@@ -0,0 +1,27 @@
+[[source]]
+name = "pypi"
+# url = "https://pypi.douban.com/simple"
+url = "https://pypi.tuna.tsinghua.edu.cn/simple"
+# url = "https://mirrors.aliyun.com/pypi/simple"
+verify_ssl = true
+
+[dev-packages]
+pycodestyle = "*"
+yapf = "*"
+pytest = "*"
+pytest-qt = "*"
+pyqt5-tools = "*" #"<5.14.1.3.0.3"
+
+[packages]
+requests = ">2.0"
+chardet = ">=3.0.4"
+preimport = ">=1.1.0"
+toml = ">=0.10.0"
+tomlconfig = ">=1.2.1"
+pyqt5 = ">=5.10.1,<5.14"
+pyqt5-sip = ">=12.7,<=12.7.1"
+qscintilla = ">=2.11.4,<=2.11.4"
+codeeditor = ">=1.1.0"
+
+# [requires]
+# python_version = "3.7"

Pipfile.lock

@@ -0,0 +1,26 @@
+自动收集QssStylesheetEditor在**windows平台上依赖**的所有文件
+
+# 准备工作
+
+dist文件夹中准备好以下文件：
+
++ libpython文件夹：python3.7的主要文件（python3.dll,python37.dll等）
++ Lib文件夹：PyQt5和requests包
++ DLLs文件夹：Windows共享库（msvcp140.dll,cvruntime140.dll,apims-win-cr-\*.dll等）
++ scripts文件夹：main.py
++ 启动文件：AppStart.exe、AppStart.vbs等
+
+# build
+
+制作windows平台安装包需要的文件的脚本。
+
+1. pipenv shell（如果使用了pipenv虚拟环境，先进入虚拟环境）
+2. cd installer（进入installer文件夹）
+3. compile_pyscripts.cmd（运行build脚本）
+
+> build文件夹是个中间文件夹，compile_pyscripts运行过程中放临时文件的。
+>
+> 最终编译的python脚本（pyc）及dll等文件会在“dist\build”文件夹中。
+
+
+> 其他平台可以忽略本脚本，当然编译为pyc的python码也可以在其他平台上运行。

docs/dev/distribution/build.md

@@ -0,0 +1,26 @@
+自动收集QssStylesheetEditor在**windows平台上依赖**的所有文件
+
+# 准备工作
+
+dist文件夹中准备好以下文件：
+
++ libpython文件夹：python3.7的主要文件（python3.dll,python37.dll等）
++ Lib文件夹：PyQt5和requests包
++ DLLs文件夹：Windows共享库（msvcp140.dll,cvruntime140.dll,apims-win-cr-\*.dll等）
++ scripts文件夹：main.py
++ 启动文件：AppStart.exe、AppStart.vbs等
+
+# build
+
+制作windows平台安装包的脚本。
+
+1. pipenv shell（如果使用了pipenv虚拟环境，先进入虚拟环境）
+2. cd installer（进入installer文件夹）
+3. compile_pyscripts.cmd（运行build脚本）
+
+> build文件夹是个中间文件夹，compile_pyscripts运行过程中放临时文件的。
+>
+> 最终编译的python脚本（pyc）及dll等文件会在“dist\build”文件夹中。
+
+
+> 其他平台可以忽略本脚本，当然编译为pyc的python码也可以在其他平台上运行。

docs/dev/distribution/build.md.bak

@@ -0,0 +1,71 @@
+打包安装程序，或者python安装包等
+
+# 打包类型
+
+可以打包为不同的类型的包，每一种包都可以安装QssStylesheetEditor，主要包括如下几种：
+
++ Windows安装包：向导式安装程序
++ python pip安装包：
+    - python zip安装包：pip可以安装的压缩包
+    - python wheel安装包（.whl）：可以用pip直接安装的包
++ 清洁源码包（.zip）：手动安装依赖后，可以运行的清洁源码（.py or .pyc）包
+
+# Windows安装包
+
+1、编译源码（py编译为pyc），收集windows平台上依赖的文件
+
+运行build文件夹中的compile_pyscripts.cmd脚本。见“docs/dev/distribution/build.md”
+
+> dist/build文件夹中的文件即为脚本生成的用于打包的文件。
+>
+> dist/build文件夹中文件实际上就是免安装的绿色版windows程序，可以直接运行。
+
+2、打包为向导式windows安装程序
+
+> 安装Nsis中文增强版
+
++ 用VNISEDIT打开“installer”文件夹中“installer.nsi”文件。
++ 编译脚本（ctl+F9）
++ dist文件夹中自动生成QssStylesheetEditor1.8_win_x64_Installer.exe
+
+> 双击“QssStylesheetEditor1.8_win_x64_Installer.exe”就可以启动安装程序。
+
+# Pip安装包
+
+> pip安装包是根据“setup.py”和“setup.cfg”生成的，不依赖于installer文件夹中的文件。
+
+**制作wheel包**
+
+执行如下命令：
+
+1. pipenv shell（如果使用了pipenv虚拟环境，先进入虚拟环境）
+2. cd QssStylesheetEditor（进入QssStylesheetEditor文件夹）
+3. python setup.py bdist_wheel（生成wheel包）
+
+dist文件中生成QssStylesheetEditor-1.8-py3-none-any.whl，可以直接发布了，直接pip  install QssStylesheetEditor-1.8-py3-none-any.whl安装就可以用了。
+
+> python setup.py bdist_rpm # rpm格式包 
+
+**制作pip安装压缩包**
+
+执行如下命令：
+
+1. pipenv shell（如果使用了pipenv虚拟环境，先进入虚拟环境）
+2. cd QssStylesheetEditor（进入QssStylesheetEditor文件夹）
+3. python setup.py sdist（生成压缩包）
+
+dist文件中生成QssStylesheetEditor-1.8.tar.gz，可以直接发布了，直接pip  install QssStylesheetEditor-1.8.tar.gz安装就可以用了。
+
+
+# 手动打包清洁源码包
+
+1. 把dist/build/scripts文件中文件拷贝出来。
+2. 把main.pyc删除
+3. 把bootstrapper.pyc文件名改为qsseditor.pyw
+
+就可以发布了。
+
+使用方法：
+
++ 用pip安装preimport、tomlconfig、CodeEditor、requests。
++ 鼠标双击 qsseditor.pyw或者命令行运行 `python qsseditor.pyw`

docs/dev/distribution/package.md

@@ -0,0 +1,61 @@
+打包安装程序，或者python安装包等
+
+# 打包类型
+
+可以打包为不同的类型的包，每一种包都可以安装QssStylesheetEditor，主要包括如下几种：
+
++ Windows安装包：向导式安装程序
++ python pip安装包：
+    - python zip安装包：pip可以安装的压缩包
+    - python wheel安装包（.whl）：可以用pip直接安装的包
++ 清洁源码包（.zip）：手动安装依赖后，可以运行的清洁源码（.py or .pyc）包
+
+# Windows安装包
+
+1、编译源码（py编译为pyc），收集windows平台上依赖的文件
+
+运行build文件夹中的compile_pyscripts.cmd脚本。见“docs/dev/distribution/build.md”
+
+> dist/build文件夹中的文件即为脚本生成的用于打包的文件。
+>
+> dist/build文件夹中文件实际上就是免安装的绿色版windows程序，可以直接运行。
+
+2、打包为向导式windows安装程序
+
+> 安装Nsis中文增强版
+
++ 用VNISEDIT打开“installer”文件夹中“installer.nsi”文件。
++ 编译脚本（ctl+F9）
++ dist文件夹中自动生成QssStylesheetEditor1.8_win_x64_Installer.exe
+
+> 双击“QssStylesheetEditor1.8_win_x64_Installer.exe”就可以启动安装程序。
+
+# Pip安装包
+
+> pip安装包是根据“setup.py”和“setup.cfg”生成的，不依赖于installer文件夹中的文件。
+
+**制作wheel包**
+
+执行如下命令：
+
+1. pipenv shell（如果使用了pipenv虚拟环境，先进入虚拟环境）
+2. cd QssStylesheetEditor（进入QssStylesheetEditor文件夹）
+3. python setup.py bdist_wheel（生成wheel包）
+
+dist文件中生成QssStylesheetEditor-1.8-py3-none-any.whl，可以直接发布了，直接pip  install QssStylesheetEditor-1.8-py3-none-any.whl安装就可以用了。
+
+> python setup.py bdist_rpm # rpm格式包 
+
+**制作pip安装压缩包**
+
+执行如下命令：
+
+1. pipenv shell（如果使用了pipenv虚拟环境，先进入虚拟环境）
+2. cd QssStylesheetEditor（进入QssStylesheetEditor文件夹）
+3. python setup.py sdist（生成压缩包）
+
+dist文件中生成QssStylesheetEditor-1.8.tar.gz，可以直接发布了，直接pip  install QssStylesheetEditor-1.8.tar.gz安装就可以用了。
+
+
+# 手动打包清洁源码包
+

docs/dev/distribution/package.md.bak

@@ -23,10 +23,10 @@ SetCompressor /SOLID /FINAL lzma  ;ʹ
 
     !define ProductName "QssStylesheetEditor"  ;产品名，和项目名相同
     !define StartFile "AppStart" ;.exe文件名,启动软件的exe名称
-    !define Version "1.7" ;版本
+    !define Version "1.8" ;版本
     !define Publisher "lileilei" ;发布人
     !define Website "https://github.com/hustlei/QssStylesheetEditor" ;网站地址
-    !define Year "2019"    
+    !define Year "2023"
     !define Brand "hustlei,${Year} @wuhan" ;品牌,作者声明
 
     ;资源

installer/installer.nsi

@@ -19,7 +19,7 @@
 
 setup(
     name="QssStylesheetEditor",  # ProjectName
-    version="1.7",
+    version="1.8",
     python_requires='>=3.0.*, <4',  # python的依赖关系
     install_requires=["requests>=2.0", "preimport>=1.1.0", "tomlconfig>=1.2.1", "CodeEditor>=1.1.0"],
 

setup.py

@@ -15,4 +15,4 @@ autoexportqss = ""
 [update]
 autocheck = ""
 checkfreq = ""
-lastcheckday = 2022-04-30
+lastcheckday = 2023-08-07