natlinkcore 5.4.2.dev5__tar.gz → 5.6.0__tar.gz

natlinkcore-5.6.0/LICENSE

@@ -0,0 +1,190 @@
+NatLink
+	(c) Copyright 1997-1999 by Joel Gould.
+		Portions (c) Copyright 1997-1999 by Dragon Systems,
+	Inc. All Rights Reserved.  Permission to use, copy, modify and
+	distribute this software (except for the files noted below) and
+	documentation for any purpose and without fee is hereby granted,
+	provided that this copyright notice appear in all copies and
+	that both the copyright notice and this permission notice appear
+	in supporting documentation, and that the name Joel Gould not be
+	used in advertising or publicity pertaining to distribution of
+	the software without specific, written permission.
+	
+	The following files are NOT covered by the previous previous
+	paragraph: NatlinkSource\speech.h and
+	NatlinkSource\dspeech.h. These files may not be redistributed
+	although they can be freely downloaded from
+	http://www.synapseadaptive.com/joel/PythonMacroSystem.html and
+	used on one machine.
+	
+	Joel Gould disclaim all warranties with regard to this software,
+	including all implied warranties of merchantability and fitness,
+	in no event shall Joel Gould be liable for any special, indirect
+	or consequential damages or any damages whatsoever resulting
+	from the loss of use, data or profits whether in an action of
+	contract, negligence or tortious action, arising out of
+	connection with the use or performance of this software.
+	Possession of this software does NOT grant the possessor any
+	license to Dragon NaturallySpeaking or any other Dragon Systems
+	product, except where license to Dragon NaturallySpeaking or any
+	other Dragon Systems products is purchased or otherwise obtained
+	separately.  This copyright only applies to NatLink, including
+	source and object code and not to Dragon NaturallySpeaking or
+	any other Dragon Systems product.  Software on this web site is
+	not available from Dragon Systems, nor is Dragon Systems
+	formally associated with this software in any way.
+
+-----------------------------------
+
+Vocola
+	Copyright (c) 2002-2012 by Rick Mohr
+
+	Portions Copyright (c) 2012-15 by Hewlett-Packard Development
+	Company, L.P.
+
+	Permission is hereby granted, free of charge, to any person
+	obtaining a copy of this software and associated documentation
+	files (the "Software"), to deal in the Software without
+	restriction, including without limitation the rights to use,
+	copy, modify, merge, publish, distribute, sublicense, and/or
+	sell copies of the Software, and to permit persons to whom the
+	Software is furnished to do so, subject to the following
+	conditions:
+
+	The above copyright notice and this permission notice shall be
+	included in all copies or substantial portions of the Software.
+
+	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+	EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+	OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+	NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+	HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+	WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+	FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+	OTHER DEALINGS IN THE SOFTWARE.
+
+-----------------------------------
+
+Configurenatlinkunimacrovocola:
+	Copyright (c) 2008 by Quintijn Hoogenboom. It may be
+	redistributed in any way as long as this copyright notice
+	remains.
+
+-----------------------------------
+
+Unimacro (c) 2002-2011 Quintijn Hoogenboom, Ben Staniford, Bart Jan 
+	     van Os 2011 Frank Olaf Sem-Jacobsen
+	
+		"unimacro" is free software; you can redistribute it
+		and/or modify it under the terms of the GNU General
+		Public License, see: http://www.gnu.org/licenses/gpl.txt
+
+		"unimacro" is distributed in the hope that it will be
+		useful, but WITHOUT ANY WARRANTY; See the GNU General
+		Public License details.
+
+"unimacro" makes use of another SourceForge project "natlink",
+which has the copyright notice shown above.
+
+-----------------------------------
+
+ConfigureNatLink.exe NLVCSetup.msi MessageWindow.dll
+	Copyright (c) 2004-2005 Applied Recognition Inc. All rights
+	reserved.
+
+	You may freely obtain this software from
+	http://speechwiki.org/NL.HomePage
+
+	Unauthorized redistribution, reverse engineering, and
+	decompilation is prohibited.
+
+	The Software comes "as is", with no warranties. None
+	whatsoever. This means no express, implied or statutory
+	warranty, including without limitation, warranties of
+	merchantability or fitness for a particular purpose or any
+	warranty of title or non-infringement.
+
+	Neither Applied Recognition Inc. nor any contributor to the
+	Software will be liable for any of those types of damages known
+	as indirect, special, consequential, or incidental related to
+	the Software or this license, to the maximum extent the law
+	permits, no matter what legal theory it's based on.
+
+	
+-----------------------------------
+
+Shared Source License for Microsoft Visual Basic Power Pack for
+Microsoft Visual Basic 2003
+
+This license governs use of the accompanying software
+(`Software'), and your use of the Software constitutes acceptance
+of this license.
+
+You may use the Software for any commercial or noncommercial purpose,
+including distributing derivative works.
+
+In return, we simply require that you agree:
+
+1. Not to remove any copyright or other notices from the Software.
+
+2. That if you distribute the Software in source code form you do so
+   only under this license (i.e. you must include a complete copy of
+   this license with your distribution), and if you distribute the
+   Software solely in object form you only do so under a license that
+   complies with this license.
+
+3. That the Software comes "as is", with no warranties. None
+   whatsoever. This means no express, implied or statutory warranty,
+   including without limitation, warranties of merchantability or
+   fitness for a particular purpose or any warranty of title or
+   non-infringement. Also, you must pass this disclaimer on whenever you
+   distribute the Software or derivative works.
+
+4. That neither Microsoft nor any contributor to the Software will be
+   liable for any of those types of damages known as indirect, special,
+   consequential, or incidental related to the Software or this license,
+   to the maximum extent the law permits, no matter what legal theory
+   it's based on. Also, you must pass this limitation of liability on
+   whenever you distribute the Software or derivative works.
+
+5. That if you sue anyone over patents that you think may apply to the
+   Software for a person's use of the Software, your license to the
+   Software ends automatically.
+
+6. That the patent rights, if any, granted in this license only apply to
+   the Software, not to any derivative works you make.
+
+7. That the Software is subject to U.S. export jurisdiction at the time
+   it is licensed to you, and it may be subject to additional export or
+   import laws in other places.  You agree to comply with all such laws
+   and regulations that may apply to the Software after delivery of the
+   software to you.
+
+8. That if you are an agency of the U.S. Government, (i) Software
+   provided pursuant to a solicitation issued on or after December 1,
+   1995, is provided with the commercial license rights set forth in
+   this license, and (ii) Software provided pursuant to a solicitation
+   issued prior to December 1, 1995, is provided with `Restricted
+   Rights' as set forth in FAR, 48 C.F.R. 52.227-14 (June 1987) or DFAR,
+   48 C.F.R. 252.227-7013 (Oct 1988), as applicable.
+
+9. That your rights under this License end automatically if you breach
+   it in any way.
+
+10. That all rights not expressly granted to you in this license are
+    reserved.
+	
+---------------------------------------
+
+
+XPCommonControls.dll
+From http://www.steepvalley.net
+
+The controls plus the source code are completely free to use. There are
+no cost at all attached to this project.
+
+This means also that I cannot take any responsibility for bugs and
+errors resulting from this code.
+
+
+----------------------------

{natlinkcore-5.4.2.dev5 → natlinkcore-5.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: natlinkcore
-Version: 5.4.2.dev5
+Version: 5.6.0
 Summary: Python portion of Natlink, a compatibility module for Dragon Naturally Speaking
 Author-email: "Quintijn Hoogenboom (maintainer)" <q.hoogenboom@antenna.nl>
 Requires-Python: >=3.10
@@ -13,11 +13,13 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
+License-File: LICENSE
 Requires-Dist: FreeSimpleGUI>=5.1.0
 Requires-Dist: pydebugstring >= 1.0.0.1
-Requires-Dist: dtactions ~= 1.6.4.dev3
+Requires-Dist: dtactions >= 1.7.0,<2
+Requires-Dist: pyuac
 Requires-Dist: platformdirs >= 4.2.0
-Requires-Dist: natlink ~= 5.5.8.dev2
+Requires-Dist: natlink >= 5.6.0,<6
 Requires-Dist: pyenvutils ; extra == "dev"
 Requires-Dist: entry-point-inspector ; extra == "dev"
 Requires-Dist: build ; extra == "dev"
@@ -39,6 +41,14 @@ You can install from [The Python Package Index (PyPI)](https://pypi.org/) with
 
 Note that natlinkcore will not install if you have not installed Natlink first.  Natlink is installed through running an installer.
 
+This will install utilties you can run from a shell prompt:  natlinkconfig_cli, natlinkconfig_gui, and natlink_extract_ini_value.
+
+You can use natlink_extract_ini_value to grab a directory or setting out of natlink.ini for copying and pasting or a shell script.
+``` 
+PS C:\Users\doug\code\dt\natlinkcore> natlink_extract_ini_value -s directories -k  dragonflyuserdirectory
+C:\Users\doug\Documents
+```
+
  
 ## Test Framework
 Tests use the [pytest](https://docs.pytest.org/) framework.  

{natlinkcore-5.4.2.dev5 → natlinkcore-5.6.0}/pyproject.toml

@@ -1,68 +1,73 @@
-[build-system]
-requires = ["flit_core >=3.2,<4", "pytest>=7.1.2"]
-build-backend = "flit_core.buildapi"
-
-[project]
-name = "natlinkcore"
-authors = [{name = "Quintijn Hoogenboom (maintainer)", email = "q.hoogenboom@antenna.nl"}]
-version="5.4.2.dev5"
-dynamic = [ "description"]
-requires-python = ">=3.10"
-readme = "readme.md"
-dependencies= [
-
-    "FreeSimpleGUI>=5.1.0", 
-    "pydebugstring >= 1.0.0.1",
-    "dtactions ~= 1.6.4.dev3",
-    "platformdirs >= 4.2.0",
-    "natlink ~= 5.5.8.dev2"
-]
-    classifiers=[
-        "Development Status :: 4 - Beta",
-        "Environment :: Win32 (MS Windows)",
-        "Intended Audience :: Developers",
-        "Operating System :: Microsoft :: Windows",
-        "Programming Language :: Python :: 3.10",
-        "Programming Language :: Python :: Implementation :: CPython",
-        "Topic :: Multimedia :: Sound/Audio :: Speech",
-        "Topic :: Software Development :: Libraries :: Python Modules"
-        ]
-[project.optional-dependencies]
-test = [
-    "pytest >=7.1.2",
-]
-dev = [
-    "pyenvutils","entry-point-inspector","build"
-] 
-
-[tool.pytest.ini_options]
-minversion = "7.1.2"
-addopts = "--capture=tee-sys "
-# very important
-#the pythonpath lets pytest load code in your source area
-#in addition to that in site-packages etc.
-#you may want to run your tests without install natlinkcore with flit or pip
-pythonpath = [
-    "src",
-    "src/natlinkcore",
-    "tests",
-]
-testpaths= [
-    "tests",
-]
-
-[project.scripts]
-natlinkconfig_cli = "natlinkcore.configure.natlinkconfig_cli:main_cli"
-natlink_extensions = "natlinkcore.configure.natlink_extensions:main"
-
-[project.gui-scripts]
-natlinkconfig_gui = "natlinkcore.configure.natlinkconfig_gui:main_gui"
-
-[project.entry-points."dt.loggers"]
-    natlink ="natlinkcore:logname"
-
-[project.entry-points."natlink.extensions"]
-natlink_sample_macros  = "natlinkcore.SampleMacros:locateme"
-
-[project.urls]
-Home = "https://github.com/dictation-toolbox/natlinkcore/"
+[build-system]
+requires = ["flit_core >=3.2,<4", "pytest>=7.1.2"]
+build-backend = "flit_core.buildapi"
+
+[project]
+name = "natlinkcore"
+authors = [{name = "Quintijn Hoogenboom (maintainer)", email = "q.hoogenboom@antenna.nl"}]
+
+version="5.6.0"
+
+dynamic = [ "description"]
+requires-python = ">=3.10"
+readme = "readme.md"
+dependencies= [
+
+    "FreeSimpleGUI>=5.1.0", 
+    "pydebugstring >= 1.0.0.1",
+    "dtactions >= 1.7.0,<2",
+    "pyuac", 
+    "platformdirs >= 4.2.0",
+    "natlink >= 5.6.0,<6"
+    # "natlink >= 5.5.8.dev2"
+]
+    classifiers=[
+        "Development Status :: 4 - Beta",
+        "Environment :: Win32 (MS Windows)",
+        "Intended Audience :: Developers",
+        "Operating System :: Microsoft :: Windows",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: Implementation :: CPython",
+        "Topic :: Multimedia :: Sound/Audio :: Speech",
+        "Topic :: Software Development :: Libraries :: Python Modules"
+        ]
+[project.optional-dependencies]
+test = [
+    "pytest >=7.1.2",
+]
+dev = [
+    "pyenvutils","entry-point-inspector","build"
+] 
+
+[tool.pytest.ini_options]
+minversion = "7.1.2"
+addopts = "--capture=tee-sys "
+# very important
+#the pythonpath lets pytest load code in your source area
+#in addition to that in site-packages etc.
+#you may want to run your tests without install natlinkcore with flit or pip
+pythonpath = [
+    "src",
+    "src/natlinkcore",
+    "tests",
+]
+testpaths= [
+    "tests",
+]
+
+[project.scripts]
+natlinkconfig_cli = "natlinkcore.configure.natlinkconfig_cli:main_cli"
+natlink_extensions = "natlinkcore.configure.natlink_extensions:main"
+natlink_extract_ini_value = "natlinkcore.configure.natlink_extract_ini_value:main"
+
+[project.gui-scripts]
+natlinkconfig_gui = "natlinkcore.configure.natlinkconfig_gui:main_gui"
+
+[project.entry-points."dt.loggers"]
+    natlink ="natlinkcore:logname"
+
+[project.entry-points."natlink.extensions"]
+natlink_sample_macros  = "natlinkcore.SampleMacros:locateme"
+
+[project.urls]
+Home = "https://github.com/dictation-toolbox/natlinkcore/"

{natlinkcore-5.4.2.dev5 → natlinkcore-5.6.0}/readme.md

@@ -1,81 +1,89 @@
-
-# Natlinkcore 
-
-## More Information
- Please refer to the README file in the project repository [https://github.com/dictation-toolbox/natlink](https://github.com/dictation-toolbox/natlink) for more information about natlink.
-
-## Installing from PyPi
-You can install from [The Python Package Index (PyPI)](https://pypi.org/) with 
-
-`py -m pip install natlinkcore`
-
-Note that natlinkcore will not install if you have not installed Natlink first.  Natlink is installed through running an installer.
-
- 
-## Test Framework
-Tests use the [pytest](https://docs.pytest.org/) framework.  
-For developers, if you are developing on the project, please add tests for any new features or bug
-fixes.  
-
-Mandy Python IDEs such as [Visual Studio Code](https://code.visualstudio.com/) have build in support for test frameworks and make it easy to run and debug pytest.   see [Visual Studio Code for testing](https://code.visualstudio.com/docs/python/testing).
-
-
-## Building the Python Package Locally
-
-`py -m build` to build the Python package locally.
-
-Publishing to PyPi is done through the [trusted publisher mechanism](https://docs.pypi.org/trusted-publishers/using-a-publisher/) when a release is created on github using github actions. 
-
-
-## Version Numbering and Publishing Checklist
-
-While you are developing, use a .dev release number.  When you are ready for alpha or beta or release candidate, use the appropriate version numbers.
-If you are submitting a pull request, the review should review and adjust the version number.  
-The version specificier is in pyroject.toml.
-
-
-The version number progression is explained in [PEP440](https://peps.python.org/pep-0440/#summary-of-permitted-suffixes-and-relative-ordering).  
-
-Hypothetical Progression of release numbers.  
-
-Working towards 5.4.0:
-- 5.4.0.dev1
-- 5.4.0.dev2
-- 5.4.0.dev_feature_x
-- 5.4.0a1
-- 5.4.0b1dev1
-- 5.4.0b1
-- 5.4.0rc1
-- 5.4.0rc2
-- 5.4.0
-
-Use alpha and beta specifiers (5.4a2, 5.4.b1, etc) to release alphas and betas.
-If you go through a release candidate phase, use 5.4rc1 etc.
-
-Non breaking changes, add a micro version number.  ie from version 5.4.1 to 5.4.2.
-Breaking changes, add a minor version number.
-
-*Before you publish to pypi*:
-- doublecheck the dependancies, especially on natlink.  You may want to specify a minimum natlink (i.e. 5.5.3) and 
-normally you should also specify that natlink has not had a breaking change by specifying the major and minor version numbers are as expected.  Note that this requires a release of natlinkcore if the minor version of natlink changes.  At minimum this will require an update to pyproject.toml and a release to pypi, even if no python code has changed. 
-
-
-
-This is how the version specifier should look for natlink (subsituting the version numbers appropriate).  In this case, we are saying that any natlink 5.5 is required, and that 
-we require greater than 5.5.7 as well because we are relying on a non-breaking change introduced in 5.5.7.
-`    "natlink ~= 5.5, >= 5.5.7"
-`
-Often, the natlink dependancy should just specify the major and minor version:
-`
-    "natlink ~= 5.5"
-`
-
-You could have a case where natlinkcore works with natlink 5.5 and 5.6, you could express this in pyproject.toml as
-    "natlink ~= 5.5, ~= 5.6".  
-
-
-## Debugging Instructions
-
-Read the detailed developer instructions for setting up the debugger.  You can look in this projects tree until 
-documentation/developers.rst.
-
+
+# Natlinkcore 
+
+## More Information
+ Please refer to the README file in the project repository [https://github.com/dictation-toolbox/natlink](https://github.com/dictation-toolbox/natlink) for more information about natlink.
+
+## Installing from PyPi
+You can install from [The Python Package Index (PyPI)](https://pypi.org/) with 
+
+`py -m pip install natlinkcore`
+
+Note that natlinkcore will not install if you have not installed Natlink first.  Natlink is installed through running an installer.
+
+This will install utilties you can run from a shell prompt:  natlinkconfig_cli, natlinkconfig_gui, and natlink_extract_ini_value.
+
+You can use natlink_extract_ini_value to grab a directory or setting out of natlink.ini for copying and pasting or a shell script.
+``` 
+PS C:\Users\doug\code\dt\natlinkcore> natlink_extract_ini_value -s directories -k  dragonflyuserdirectory
+C:\Users\doug\Documents
+```
+
+ 
+## Test Framework
+Tests use the [pytest](https://docs.pytest.org/) framework.  
+For developers, if you are developing on the project, please add tests for any new features or bug
+fixes.  
+
+Mandy Python IDEs such as [Visual Studio Code](https://code.visualstudio.com/) have build in support for test frameworks and make it easy to run and debug pytest.   see [Visual Studio Code for testing](https://code.visualstudio.com/docs/python/testing).
+
+
+## Building the Python Package Locally
+
+`py -m build` to build the Python package locally.
+
+Publishing to PyPi is done through the [trusted publisher mechanism](https://docs.pypi.org/trusted-publishers/using-a-publisher/) when a release is created on github using github actions. 
+
+
+## Version Numbering and Publishing Checklist
+
+While you are developing, use a .dev release number.  When you are ready for alpha or beta or release candidate, use the appropriate version numbers.
+If you are submitting a pull request, the review should review and adjust the version number.  
+The version specificier is in pyroject.toml.
+
+
+The version number progression is explained in [PEP440](https://peps.python.org/pep-0440/#summary-of-permitted-suffixes-and-relative-ordering).  
+
+Hypothetical Progression of release numbers.  
+
+Working towards 5.4.0:
+- 5.4.0.dev1
+- 5.4.0.dev2
+- 5.4.0.dev_feature_x
+- 5.4.0a1
+- 5.4.0b1dev1
+- 5.4.0b1
+- 5.4.0rc1
+- 5.4.0rc2
+- 5.4.0
+
+Use alpha and beta specifiers (5.4a2, 5.4.b1, etc) to release alphas and betas.
+If you go through a release candidate phase, use 5.4rc1 etc.
+
+Non breaking changes, add a micro version number.  ie from version 5.4.1 to 5.4.2.
+Breaking changes, add a minor version number.
+
+*Before you publish to pypi*:
+- doublecheck the dependancies, especially on natlink.  You may want to specify a minimum natlink (i.e. 5.5.3) and 
+normally you should also specify that natlink has not had a breaking change by specifying the major and minor version numbers are as expected.  Note that this requires a release of natlinkcore if the minor version of natlink changes.  At minimum this will require an update to pyproject.toml and a release to pypi, even if no python code has changed. 
+
+
+
+This is how the version specifier should look for natlink (subsituting the version numbers appropriate).  In this case, we are saying that any natlink 5.5 is required, and that 
+we require greater than 5.5.7 as well because we are relying on a non-breaking change introduced in 5.5.7.
+`    "natlink ~= 5.5, >= 5.5.7"
+`
+Often, the natlink dependancy should just specify the major and minor version:
+`
+    "natlink ~= 5.5"
+`
+
+You could have a case where natlinkcore works with natlink 5.5 and 5.6, you could express this in pyproject.toml as
+    "natlink ~= 5.5, ~= 5.6".  
+
+
+## Debugging Instructions
+
+Read the detailed developer instructions for setting up the debugger.  You can look in this projects tree until 
+documentation/developers.rst.
+