Metadata-Version: 2.3
Name: unimacro
Version: 4.1.7.dev2
Summary: Unimacro __init__
Author-email: "Quintijn Hoogenboom (maintainer)" <q.hoogenboom@antenna.nl>
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
Classifier: Topic :: Scientific/Engineering :: Human Machine Interfaces
Classifier: Environment :: Win32 (MS Windows)
Classifier: Intended Audience :: Developers
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: dtactions ~= 1.6.4.dev3
Requires-Dist: debugpy >= 1.2.0
Requires-Dist: pywin32 >= 304
Requires-Dist: natlinkcore ~= 5.4.2.dev1
Requires-Dist: FreeSimpleGUI>=5.1.0
Requires-Dist: pyenvutils ; extra == "dev"
Requires-Dist: entry-point-inspector ; extra == "dev"
Requires-Dist: build ; extra == "dev"
Requires-Dist: pytest >=7.1.2 ; extra == "test"
Requires-Dist: flake8 ; extra == "test"
Project-URL: homepage, https://qh.antenna.nl/unimacro/
Project-URL: repository, https://github.com/dictation-toolbox/unimacro
Project-URL: source, https://github.com/dictation-toolbox/unimacro
Provides-Extra: dev
Provides-Extra: test

# 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.

A limited number of grammars are by default available when you install unimacro:

  _control.py
  _general.py 
  _folders.py
  _lines.py
  _brackets.py
  _tags.py
  _tasks.py
  _clickbyvoice.py
  _number simple.py

## Install unimacro

Install from the [Python Package Index](https://pypi.org/)
with the following.

`pip install unimacro`

But... when you install Natlink via the natlink installer, and proceed with "Configure Natlink via GUI" or "Configure Natlink via CLI", and choose to activate Unimacro, this "pip" action is automatically performed. 

If you want to install directly from github (say to install something between releases a developer is working on).

```
pip uninstall unimacro
pip install unimacro@git+https://github.com/dougransom/unimacro@d1cbfb0d9559b9ba656a1d1bb1579f1c2b2562ae
```
replacing "https://github.com/dougransom/unimacro"  with the repository in github you wish to install from and "d1cbfb0d9559b9ba656a1d1bb1579f1c2b2562ae" with the version commit you wish to install.    


# Location of Grammars

The Grammars listed above are installed with Unimacro in:
the Lib\site-packages\unimacro\UnimacroGrammars sub-directory of your 
Python installation.  

More about [Unimacro Grammars](https://qh.antenna.nl/unimacro/grammars/globalgrammars/folders/index.html)

# Developer instructions.

If you want to install your local unimacro development environment as the working unimacro:
`pip install -e .[dev,test] `.  

`py -m build` to build the Python package locally.

To publish a release to [Python Packaging Index](https://pypi.org/), [draft a new release](https://github.com/dictation-toolbox/unimacro/releases). 






