plover-console-ui


Nameplover-console-ui JSON
Version 1.1.3 PyPI version JSON
download
home_pagehttps://github.com/psethwick/plover_console_ui
SummaryText User Interface for Plover
upload_time2021-04-08 11:10:15
maintainer
docs_urlNone
authorSeth Rider
requires_python
licenseGNU General Public License v3 or later (GPLv3+)
keywords plover plover_plugin cli
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ############################
Console UI Plugin for Plover
############################

.. image:: https://img.shields.io/pypi/v/plover_console_ui.svg
    :target: https://pypi.org/project/plover-console-ui/
.. image:: https://img.shields.io/pypi/dm/plover_console_ui.svg
    :target: https://pypi.org/project/plover-console-ui/

This is a plugin for the open source stenography program `Plover <https://www.openstenoproject.org/plover/>`_

Requires Plover version 4.0.0 or later

Run Plover entirely inside your terminal window!

.. image:: console-ui.png

###############
Getting Started
###############

1. Open Plover
#. Navigate to the Plugin Manager tool
#. Select ``plover_console_ui`` in the list
#. Click install

Or directly install ``plover_console_ui`` into Plover's python environment

Linux/Mac
=========

Start Plover with the --gui option:
``plover --gui console``

Windows
=======

Due to some Windows workaround code (in Plover), this plugin does not work well on the packaged Windows build

Here's a launcher that works:
``python -m plover --gui console``

Yes, it requires essentially 'run from source'... I'm sorry

#####
Usage
#####

Regular Use
===========

Plover commands are all functional:

- ``{PLOVER:LOOKUP}``
- ``{PLOVER:ADD_TRANSLATION}``
- ``{PLOVER:SUSPEND}``
- ``{PLOVER:RESUME}``
- ``{PLOVER:TOGGLE}``
- ``{PLOVER:FOCUS}``
- ``{PLOVER:CONFIGURE}``

Note for the commands which do window manager focus:

- ``LOOKUP``
- ``ADD_TRANSLATION``
- ``FOCUS``
- ``CONFIGURE``

This ``console_ui`` only knows which window it lives in *if* that window has focus on start-up

Otherwise: expect the focus feature not to work

Key Commands
============

These key commands are always available when ``console_ui`` has focus:

- ``Ctrl-C`` or ``Ctrl-Q``: Exits Plover
- ``PageUp/PageDown``: Scrolls the ``console`` buffer up/down

  (Note: if anything new is added to ``console`` it will auto-scroll back down)

Command Line
============

The ``help`` command is *always* available and will show all the currently
available commands

If a command has the description ``...`` there are further commands
contained inside

Commands can be partially entered

    ``m`` to use the ``machine`` command

Once you know your way around, you don't need to enter each menu one at a time

    ``col for goldenrod`` from the top level

Case is ignored 

    ``configure`` is the same as ``CONFIGURE``

To get back to the previous menu level, press ``Enter`` on its own

If a command has ``<>`` in its description it takes one or more arguments. The type
of the argument is between the ``<>``

Commands
========

- ``addtranslation``: enters ``ADD_TRANSLATION`` mode
- ``lookup``: enters ``LOOKUP`` mode
- ``output``: toggles Plover output on/off
- ``reset``: reconnects current ``machine`` (reloads dictionaries)
- ``suggestions``: toggles suggestions display
- ``tape``: toggles paper tape display
- ``savetape``: saves content of tape to a file
- ``dictionaries``: configure dictionaries

  - ``add``: add a dictionary by its file path
  - ``remove``: remove a dictionary by displayed number
  - ``toggle``: toggle a dictionary by displayed number
  - ``priority``: prioritise a dictionary by displayed number (to its new number)

- ``machine``: configure ``machine``

  - ``options``: configure current machine options
  - (One 'set machine' command per installed ``machine`` plugin)

- ``system``: configure ``system``

  - (One 'set system' command per installed ``system`` plugin)

- ``configure``: Plover configuration commands (changes reload dictionaries)

  - ``space_placement``: (Before Output|After Output)
  - ``start_attached``: (True|False)
  - ``start_capitalized``: (True|False)
  - ``undo_levels``: Number of undo levels
  - ``log_file_name``: Name of the log file
  - ``enable_stroke_logging``: Enable/Disable stroke logging
  - ``enable_translation_logging``: Enable/Disable translation logging
  - ``auto_start``: If 'True' enable Plover output on start-up
  - ``extensions``: Enable/Disable extension commands

    - (One 'toggle extension' command per installed ``extension`` plugin)

- ``colors``: set ``console_ui`` colors

  These commands take `web color names
  <https://www.w3schools.com/colors/colors_names.asp>`_

  Color hexes are also supported (e.g. ``#ffffff`` for white)

  (Note: not all terminals support all colors)

  - ``foreground``: set foreground color
  - ``background``: set background color

- ``loglevel``: configure which Plover log messages will get printed to ``console_ui``

  - ``WARNING``: any logs at ``WARNING`` or above will be printed
  - ``CRITICAL``: any logs at ``CRITICAL`` or above will be printed
  - ``ERROR``: any logs at ``ERROR`` or above will be printed
  - ``INFO``: any logs at ``INFO`` or above will be printed
  - ``DEBUG``: any logs at ``DEBUG`` or above will be printed

- ``exit``: exits ``console_ui`` (and Plover)

############
Contributing
############

Head to the `open source repository <https://github.com/psethwick/plover_console_ui>`_

Issues + PRs welcome!



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/psethwick/plover_console_ui",
    "name": "plover-console-ui",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "plover plover_plugin cli",
    "author": "Seth Rider",
    "author_email": "seth.rider@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/a8/36/5ad7337c8cf01e5688eee3e3c2aa996ac05683680e64700cfaaa97ed29ba/plover_console_ui-1.1.3.tar.gz",
    "platform": "",
    "description": "############################\nConsole UI Plugin for Plover\n############################\n\n.. image:: https://img.shields.io/pypi/v/plover_console_ui.svg\n    :target: https://pypi.org/project/plover-console-ui/\n.. image:: https://img.shields.io/pypi/dm/plover_console_ui.svg\n    :target: https://pypi.org/project/plover-console-ui/\n\nThis is a plugin for the open source stenography program `Plover <https://www.openstenoproject.org/plover/>`_\n\nRequires Plover version 4.0.0 or later\n\nRun Plover entirely inside your terminal window!\n\n.. image:: console-ui.png\n\n###############\nGetting Started\n###############\n\n1. Open Plover\n#. Navigate to the Plugin Manager tool\n#. Select ``plover_console_ui`` in the list\n#. Click install\n\nOr directly install ``plover_console_ui`` into Plover's python environment\n\nLinux/Mac\n=========\n\nStart Plover with the --gui option:\n``plover --gui console``\n\nWindows\n=======\n\nDue to some Windows workaround code (in Plover), this plugin does not work well on the packaged Windows build\n\nHere's a launcher that works:\n``python -m plover --gui console``\n\nYes, it requires essentially 'run from source'... I'm sorry\n\n#####\nUsage\n#####\n\nRegular Use\n===========\n\nPlover commands are all functional:\n\n- ``{PLOVER:LOOKUP}``\n- ``{PLOVER:ADD_TRANSLATION}``\n- ``{PLOVER:SUSPEND}``\n- ``{PLOVER:RESUME}``\n- ``{PLOVER:TOGGLE}``\n- ``{PLOVER:FOCUS}``\n- ``{PLOVER:CONFIGURE}``\n\nNote for the commands which do window manager focus:\n\n- ``LOOKUP``\n- ``ADD_TRANSLATION``\n- ``FOCUS``\n- ``CONFIGURE``\n\nThis ``console_ui`` only knows which window it lives in *if* that window has focus on start-up\n\nOtherwise: expect the focus feature not to work\n\nKey Commands\n============\n\nThese key commands are always available when ``console_ui`` has focus:\n\n- ``Ctrl-C`` or ``Ctrl-Q``: Exits Plover\n- ``PageUp/PageDown``: Scrolls the ``console`` buffer up/down\n\n  (Note: if anything new is added to ``console`` it will auto-scroll back down)\n\nCommand Line\n============\n\nThe ``help`` command is *always* available and will show all the currently\navailable commands\n\nIf a command has the description ``...`` there are further commands\ncontained inside\n\nCommands can be partially entered\n\n    ``m`` to use the ``machine`` command\n\nOnce you know your way around, you don't need to enter each menu one at a time\n\n    ``col for goldenrod`` from the top level\n\nCase is ignored \n\n    ``configure`` is the same as ``CONFIGURE``\n\nTo get back to the previous menu level, press ``Enter`` on its own\n\nIf a command has ``<>`` in its description it takes one or more arguments. The type\nof the argument is between the ``<>``\n\nCommands\n========\n\n- ``addtranslation``: enters ``ADD_TRANSLATION`` mode\n- ``lookup``: enters ``LOOKUP`` mode\n- ``output``: toggles Plover output on/off\n- ``reset``: reconnects current ``machine`` (reloads dictionaries)\n- ``suggestions``: toggles suggestions display\n- ``tape``: toggles paper tape display\n- ``savetape``: saves content of tape to a file\n- ``dictionaries``: configure dictionaries\n\n  - ``add``: add a dictionary by its file path\n  - ``remove``: remove a dictionary by displayed number\n  - ``toggle``: toggle a dictionary by displayed number\n  - ``priority``: prioritise a dictionary by displayed number (to its new number)\n\n- ``machine``: configure ``machine``\n\n  - ``options``: configure current machine options\n  - (One 'set machine' command per installed ``machine`` plugin)\n\n- ``system``: configure ``system``\n\n  - (One 'set system' command per installed ``system`` plugin)\n\n- ``configure``: Plover configuration commands (changes reload dictionaries)\n\n  - ``space_placement``: (Before Output|After Output)\n  - ``start_attached``: (True|False)\n  - ``start_capitalized``: (True|False)\n  - ``undo_levels``: Number of undo levels\n  - ``log_file_name``: Name of the log file\n  - ``enable_stroke_logging``: Enable/Disable stroke logging\n  - ``enable_translation_logging``: Enable/Disable translation logging\n  - ``auto_start``: If 'True' enable Plover output on start-up\n  - ``extensions``: Enable/Disable extension commands\n\n    - (One 'toggle extension' command per installed ``extension`` plugin)\n\n- ``colors``: set ``console_ui`` colors\n\n  These commands take `web color names\n  <https://www.w3schools.com/colors/colors_names.asp>`_\n\n  Color hexes are also supported (e.g. ``#ffffff`` for white)\n\n  (Note: not all terminals support all colors)\n\n  - ``foreground``: set foreground color\n  - ``background``: set background color\n\n- ``loglevel``: configure which Plover log messages will get printed to ``console_ui``\n\n  - ``WARNING``: any logs at ``WARNING`` or above will be printed\n  - ``CRITICAL``: any logs at ``CRITICAL`` or above will be printed\n  - ``ERROR``: any logs at ``ERROR`` or above will be printed\n  - ``INFO``: any logs at ``INFO`` or above will be printed\n  - ``DEBUG``: any logs at ``DEBUG`` or above will be printed\n\n- ``exit``: exits ``console_ui`` (and Plover)\n\n############\nContributing\n############\n\nHead to the `open source repository <https://github.com/psethwick/plover_console_ui>`_\n\nIssues + PRs welcome!\n\n\n",
    "bugtrack_url": null,
    "license": "GNU General Public License v3 or later (GPLv3+)",
    "summary": "Text User Interface for Plover",
    "version": "1.1.3",
    "split_keywords": [
        "plover",
        "plover_plugin",
        "cli"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "4e9c14f4f4e6198336a81ca545163b43",
                "sha256": "7a16992916b7cd6506b66b48f880385f7519f2ff010e7634e211281c33b9d0e1"
            },
            "downloads": -1,
            "filename": "plover_console_ui-1.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4e9c14f4f4e6198336a81ca545163b43",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 30405,
            "upload_time": "2021-04-08T11:10:13",
            "upload_time_iso_8601": "2021-04-08T11:10:13.873273Z",
            "url": "https://files.pythonhosted.org/packages/e0/64/df939994120e3fb73e58f650f52d8650499fb7e2669f2c9c633abe8468d3/plover_console_ui-1.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "9e1823b64fc3c7946bef755a75a3debb",
                "sha256": "780ffee502d60179353d45c7b226da045e2f370f2d4d002c128c0c952c8fbfb5"
            },
            "downloads": -1,
            "filename": "plover_console_ui-1.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "9e1823b64fc3c7946bef755a75a3debb",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 16225,
            "upload_time": "2021-04-08T11:10:15",
            "upload_time_iso_8601": "2021-04-08T11:10:15.064075Z",
            "url": "https://files.pythonhosted.org/packages/a8/36/5ad7337c8cf01e5688eee3e3c2aa996ac05683680e64700cfaaa97ed29ba/plover_console_ui-1.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-04-08 11:10:15",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "psethwick",
    "error": "Could not fetch GitHub repository",
    "lcname": "plover-console-ui"
}
        
Elapsed time: 0.24218s