Metadata-Version: 2.1
Name: plover-python-dictionary-lib
Version: 0.2.5
Summary: Library for writing Python dictionary for Plover, and generating JSON dictionary file from Python dictionary.
Home-page: https://github.com/user202729/plover-python-dictionary-lib
Author: user202729
License: GNU General Public License v3 or later (GPLv3+)
Keywords: plover
Platform: UNKNOWN
Classifier: Environment :: Plugins
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
Requires-Dist: plover-stroke (>=0.4.0)

# plover-python-dictionary-lib
Library for writing Python dictionary for Plover,
and generating JSON dictionary file from Python dictionary.

This package is available on 
[PyPI](https://pypi.org/project/plover-python-dictionary-lib/).
To install it, run the command

```bash
pip install plover-python-dictionary-lib
```


Example & usage: See [`example/` folder](https://github.com/user202729/plover-python-dictionary-lib/tree/main/example) (on GitHub).

To generate JSON (the Python dictionary must be written with this plugin),
call `.print_items()` on the main `Dictionary` object. For example if this code
is included at the end of the Python dictionary file named `dictionary.py`

```python
if __name__=="__main__":
	dictionary.print_items()
```

(assuming that the main dictionary object is named `dictionary`) then running `python dictionary.py`
will print the dictionary as JSON to the standard output.


