Merge pull request #3 from dictation-toolbox/master

grab latest
dictation-toolbox · Feb 18, 2021 · 3f21376 · 3f21376
2 parents adf8c97 + 8e7dd56
commit 3f21376
Show file tree

Hide file tree

Showing 394 changed files with 1,184 additions and 714 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,11 +1,11 @@
-/*.pyc
-/actionclasses/*.pyc
+__pycache__/
 /grammar.bin
 /unimacro_test/*.pyc
-/actionclasses/__pycache__/*.pyc
 *.bak
-__pycache__
 /unimacro_test/testresult.txt
 /_number extended.py
 /_repeat.py
 .vscode/launch.json
+/dist
+/configurenatlink_error.txt
+/README.html
diff --git a/COPYRIGHT.txt → LICENSE.txt b/COPYRIGHT.txt → LICENSE.txt
diff --git a/Packaging Python Projects — Python Packaging User Guide.url b/Packaging Python Projects — Python Packaging User Guide.url
@@ -0,0 +1,2 @@
+[InternetShortcut]
+URL=https://packaging.python.org/tutorials/packaging-projects/
diff --git a/README.md b/README.md
@@ -1,6 +1,55 @@
-This is the repository which was previously with subversion on sourceforge.net.
+# Unimacro
+The Unimacro project aims to provide a rich set of command grammars, that can be configured by the users without programming knowledge. 
+Read more at [Natlink, including Unimacro and Vocolaa](https://qh.antenna.nl/unimacro/index.html)
+
+# Installing
+
+Unimacro is reasonably stable, but still in alpha.  Check the [Unimacro Issues](https://github.com/dictation-toolbox/unimacro/issues) to see the problem
+areas - probably nothing you can't live without.
+
+
+
+## Install a prerelease of [Python for Win 32](https://github.com/mhammond/pywin32) 
+The latest the version of [Python for Win 32](https://github.com/mhammond/pywin32)  in the Python Packing Index (300) has some bugs that affect Unimacro.
+So you need to install a later version.
+
+You can download can updated pywin32 from https://github.com/mhammond/pywin32/pull/1622/checks, click on Artifacts,  download the artifacts, extract the files to your computer somehwhere.  
+
+In a shell with administrator privileges, 
+`pip install --force-reinstall .\pywin32-300.1-cp38-cp38-win32.whl`.
+
+## Install unimacro
+
+Install from the [Test Python Package Index](https://test.pypi.org/)
+with the following.
+
+`pip install --no-cache --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple unimacro`
+
+
+# Location of Grammars
+
+Grammars installed with Unimacro will be installed in:
+the Lib\site-packages\unimacro\UnimacroGrammars sub-directory of your 
+Python installation.  Good ones to start with include _folders.py and _clickbyvoice.py 
+as most users will  find web and file system navigation by voice useful.
+
+More about [Unimacro Grammars](https://qh.antenna.nl/unimacro/grammars/globalgrammars/folders/index.html)
+
+# Developer instructions.
+
+Follow the instructions for [Natlink](https://test.pypi.org/project/natlinkpy/), replacing 'natlink' with 'unimacro'.
+The same commands for building packages and publishing are available in the unimacro root.
+
+If you wish to build or publish a package, there are:
+
+- build_package.ps1 and build_package.ps1 to build the packages.  
+- publish_package_pypi.ps1/.cmd to upload the package to the  [Python Packaging Index](https://pypi.org/)
+- publish_package_testpypi.ps1/.cmd to upload the packkage to the [Test Python Packaging Index](https://test.pypi.org/)
+
+
+
+
+
+
 
-Information about this project, which goes together with Natlink2, on 
-https://qh.antenna.nl/unimacro/index.html
 
-Quintijn Hoogenboom, Sept 27, 2019.
diff --git a/Why use Flit- — Flit 3.0.0 documentation.url b/Why use Flit- — Flit 3.0.0 documentation.url
@@ -0,0 +1,2 @@
+[InternetShortcut]
+URL=https://flit.readthedocs.io/en/latest/rationale.html
diff --git a/__init__.py b/__init__.py
diff --git a/actionclasses/komodo-actions.py b/actionclasses/komodo-actions.py
diff --git a/build_package.cmd b/build_package.cmd
@@ -0,0 +1 @@
+flit build --format sdist  --no-setup-py
diff --git a/build_package.ps1 b/build_package.ps1
@@ -0,0 +1,4 @@
+#build an sdist (source distribution) package for unimacro
+#no wheel is built, one less thing to worry about
+#use the no-setup option, which requires a 
+flit build --format sdist  --no-setup-py
diff --git a/building_and_publishing_packages.txt b/building_and_publishing_packages.txt
@@ -0,0 +1,64 @@
+
+
+Packages are build without a setup.py, and source only, as any PIP recent enough will be PEP517 compliant.
+Flit is the simplest packaging tool that will work. Read about it here https://flit.readthedocs.io/en/latest/cmdline.html.
+
+Getting Ready to Publish a Package.
+9
+Get your credentials for pypi and testpypi and add them to your ~\.pypirc.  ~\.pypirc
+seems very finicky even though it looks like a text file.  If publishing to pypi or testpypi is
+new it is suggested you copy pypirc_template to ~/.pypirc and add your token from your accounts for PyPi/TestPyPi.
+(see in the natlink repository for this template)
+
+Customizing the Package for PyPi:
+
+Read https://flit.readthedocs.io/en/latest/pyproject_toml.html  to see how to customize the description on PyPi,
+licensing, etc.   
+
+To build a package:
+
+Ensure you have flit ("pip install flit")
+
+Update the version number of the package.  Make the number bigger in src/unimacro/__init__.py than it was the last time
+a package was uploaded to TestPypi or PyPi.  Flit uses that number as the release number on pypi.
+
+Start a power shell in the root of your git clone.  if you are used to command shell, type "powershell" and that 
+will launch a windows powershell.  
+
+enter the command "build-package".   That should work.  if you have untraccked git files you need to 
+address them by addding to .gitignore or adding to git.
+
+
+To test  a package.
+
+If that works, and you want to see if it works, i suggest uploading to testpypi.
+use the powershell command:
+
+publish_package_testpypi
+
+if it publishes, then you will see the updated version number in natlink on testpypi https://test.pypi.org/search/?q=natlink
+
+Now install it using pip with this:
+
+pip --no-cache install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple  unimacro
+
+Remove any local projects for natlink from any Python Path variables, so that the version in site-packages gets loaded by
+natlink.  You can rename your dictation-toolbox root temporarily below which natlink lies, or your can temporarily rename
+natlink to something like dev_natlink.
+
+
+
+To Publish a Package on PyPi after testing.
+
+You can't undo publishing a package on PyPi, so get it working on TestPyPi first.
+
+Then publish to testpypi using publish_package_pypy in powershell.
+
+
+
+
+
+
+
+
+
diff --git a/compile_README.cmd b/compile_README.cmd
@@ -0,0 +1,5 @@
+@echo for testing the README.md.  
+@echo the outpout is not used for publishing.  it is only so you know your README.md will
+@echo compile ok before publishing with flit.
+
+python -m markdown README.md > README.html
diff --git a/fix_pywin32/pywin32-300.1-cp37-cp37m-win32.whl b/fix_pywin32/pywin32-300.1-cp37-cp37m-win32.whl
diff --git a/fix_pywin32/pywin32-300.1-cp38-cp38-win32.whl b/fix_pywin32/pywin32-300.1-cp38-cp38-win32.whl
diff --git a/packaging instructions.txt b/packaging instructions.txt
@@ -0,0 +1,2 @@
+To create the package for upload to PyPy etc,
+run the powershell script build_package.ps1
diff --git a/publish_package_pypi.cmd b/publish_package_pypi.cmd
@@ -0,0 +1 @@
+flit publish  --format sdist  --no-setup-py  --repository pypi
diff --git a/publish_package_pypi.ps1 b/publish_package_pypi.ps1
@@ -0,0 +1,4 @@
+#build an sdist (source distribution) package for unimacro
+#no wheel is built, one less thing to worry about
+#use the no-setup option, which requires a 
+flit publish  --format sdist  --no-setup-py  --repository pypi
diff --git a/publish_package_tesetpypi.cmd b/publish_package_tesetpypi.cmd
@@ -0,0 +1 @@
+flit publish  --format sdist  --no-setup-py  --repository testpypi
diff --git a/publish_package_testpypi.ps1 b/publish_package_testpypi.ps1
@@ -0,0 +1,4 @@
+#build an sdist (source distribution) package for unimacro
+#no wheel is built, one less thing to worry about
+#use the no-setup option, which requires a 
+flit publish  --format sdist  --no-setup-py  --repository testpypi
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,27 @@
+[build-system]
+requires = ["flit_core >=2,<4"]
+build-backend = "flit_core.buildapi"
+
+[tool.flit.metadata]
+module="unimacro"
+author = "Quintijn Hoogenboom"
+author-email = "[email protected]"
+home-page = "https://qh.antenna.nl/unimacro/"
+description-file = "README.md"
+
+requires=["natlink",
+		  "debugpy >= 1.2.0",
+		  "pywin32 >= 300"]
+
+
+classifiers=[	"Development Status :: 4 - Beta",
+				"Topic :: Multimedia :: Sound/Audio :: Speech",
+				"Topic :: Scientific/Engineering :: Human Machine Interfaces",
+				]
+
+requires-python = ">=3.8"
+keywords="dragon,speech,dictation,dictation-toolobx,unimacro,natlink"
+
+[tool.flit.scripts]
+
+
diff --git a/BrowseGrammar.py → src/unimacro/BrowseGrammar.py b/BrowseGrammar.py → src/unimacro/BrowseGrammar.py
diff --git a/BrowseGrammarApp.py → src/unimacro/BrowseGrammarApp.py b/BrowseGrammarApp.py → src/unimacro/BrowseGrammarApp.py
diff --git a/D_.py → src/unimacro/D_.py b/D_.py → src/unimacro/D_.py
diff --git a/D_train.py → src/unimacro/D_train.py b/D_train.py → src/unimacro/D_train.py
diff --git a/DialogServer.py → src/unimacro/DialogServer.py b/DialogServer.py → src/unimacro/DialogServer.py
diff --git a/DisabledGrammars/README.txt → src/unimacro/DisabledGrammars/README.txt b/DisabledGrammars/README.txt → src/unimacro/DisabledGrammars/README.txt
diff --git a/DisabledGrammars/_editcomments.py → ...nimacro/DisabledGrammars/_editcomments.py b/DisabledGrammars/_editcomments.py → ...nimacro/DisabledGrammars/_editcomments.py
diff --git a/DisabledGrammars/_first_sample_docstring.py → ...sabledGrammars/_first_sample_docstring.py b/DisabledGrammars/_first_sample_docstring.py → ...sabledGrammars/_first_sample_docstring.py
diff --git a/DisabledGrammars/_modes.py → src/unimacro/DisabledGrammars/_modes.py b/DisabledGrammars/_modes.py → src/unimacro/DisabledGrammars/_modes.py
diff --git a/DisabledGrammars/_number extended.py → ...acro/DisabledGrammars/_number extended.py b/DisabledGrammars/_number extended.py → ...acro/DisabledGrammars/_number extended.py
diff --git a/DisabledGrammars/_setpriority.py → ...unimacro/DisabledGrammars/_setpriority.py b/DisabledGrammars/_setpriority.py → ...unimacro/DisabledGrammars/_setpriority.py
diff --git a/DisabledGrammars/_shownumbersplus.py → ...acro/DisabledGrammars/_shownumbersplus.py b/DisabledGrammars/_shownumbersplus.py → ...acro/DisabledGrammars/_shownumbersplus.py
diff --git a/DisabledGrammars/_tasks.py → src/unimacro/DisabledGrammars/_tasks.py b/DisabledGrammars/_tasks.py → src/unimacro/DisabledGrammars/_tasks.py
diff --git a/DisabledGrammars/firefox_browsing.py → ...acro/DisabledGrammars/firefox_browsing.py b/DisabledGrammars/firefox_browsing.py → ...acro/DisabledGrammars/firefox_browsing.py
diff --git a/...bledGrammars/natspeak_sample_docstring.py → ...bledGrammars/natspeak_sample_docstring.py b/...bledGrammars/natspeak_sample_docstring.py → ...bledGrammars/natspeak_sample_docstring.py
diff --git a/DisabledGrammars/winword_styles_unimacro.py → ...sabledGrammars/winword_styles_unimacro.py b/DisabledGrammars/winword_styles_unimacro.py → ...sabledGrammars/winword_styles_unimacro.py
diff --git a/TrainDialog.py → src/unimacro/TrainDialog.py b/TrainDialog.py → src/unimacro/TrainDialog.py
diff --git a/UnimacroGrammars/README.txt → src/unimacro/UnimacroGrammars/README.txt b/UnimacroGrammars/README.txt → src/unimacro/UnimacroGrammars/README.txt
diff --git a/UnimacroGrammars/_brackets.py → src/unimacro/UnimacroGrammars/_brackets.py b/UnimacroGrammars/_brackets.py → src/unimacro/UnimacroGrammars/_brackets.py
diff --git a/UnimacroGrammars/_calculator.py → src/unimacro/UnimacroGrammars/_calculator.py b/UnimacroGrammars/_calculator.py → src/unimacro/UnimacroGrammars/_calculator.py
diff --git a/UnimacroGrammars/_clickbyvoice.py → ...nimacro/UnimacroGrammars/_clickbyvoice.py b/UnimacroGrammars/_clickbyvoice.py → ...nimacro/UnimacroGrammars/_clickbyvoice.py
diff --git a/UnimacroGrammars/_debug_natlink.py → ...imacro/UnimacroGrammars/_debug_natlink.py b/UnimacroGrammars/_debug_natlink.py → ...imacro/UnimacroGrammars/_debug_natlink.py
diff --git a/UnimacroGrammars/_folders.py → src/unimacro/UnimacroGrammars/_folders.py b/UnimacroGrammars/_folders.py → src/unimacro/UnimacroGrammars/_folders.py
@@ -2711,8 +2711,8 @@ def makeFromTemplateAndExecute(unimacrofolder, templatefile, unimacrogrammarsfol
 
     outputpath = os.path.join(unimacrogrammarsfolder, outputfile)
     readwritefile.writeAnything(outputpath, encoding, bom, Text)
-    print('wrote to: %s'% outputfile)
-    print(f'output dialog: {outputpath}, python: {pythonexe}')
+    # print('wrote to: %s'% outputfile)
+    # print(f'output dialog: {outputpath}, python: {pythonexe}')
     UnimacroBringUp(pythonexe.normpath(), outputpath)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		[InternetShortcut]
		URL=https://packaging.python.org/tutorials/packaging-projects/
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		[InternetShortcut]
		URL=https://flit.readthedocs.io/en/latest/rationale.html
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		To create the package for upload to PyPy etc,
		run the powershell script build_package.ps1
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		flit publish --format sdist --no-setup-py --repository pypi