paulfioravanti / plover-1password

Plover plugin to enable steno outlines to retrieve secrets from 1Password.
https://pypi.org/project/plover-1password/
GNU General Public License v3.0
0 stars 0 forks source link

Extension plugin not showing up in the Plover Configuration Plugins UI on Windows after installation #1

Closed paulfioravanti closed 1 month ago

paulfioravanti commented 2 months ago

On Windows, when you attempt to install the Plover 1Password plugin via the Plover Plugin Manager, it would seem to error out on not being able to find the onepassword module that is provided by the 1Password Python SDK.

This results in the extension not being available in the Plover Configuration Plugins UI on Windows after installation. In order to fix this issue, until the 1Password Python SDK is published to PyPI, manual installation and minor configuration changes will be necessary for Windows users. In a directory of your choosing (eg C:\Users\<your user name>\steno etc), run the following commands in Powershell:

git clone git@github.com:paulfioravanti/plover-1password.git
cd plover-1password
notepad setup.cfg

In the setup.cfg file, add the onepassword SDK as a direct URL dependency of the plugin:

[options]
install_requires =
    plover >= 4.0.0.dev12
    onepassword @ git+https://git@github.com/1Password/onepassword-sdk-python.git@v0.1.1

After saving the setup.cfg file, open up another Powershell command line to manually install the Plover 1Password plugin (from wherever you cloned the directory to):

cd C:\Program Files\Open Steno Project\Plover 4.0.0rc2
.\plover_console.exe --script plover_plugins install C:\Users\<your user name>\steno\plover-1password

After installing via this method, the plover_1password plugin should show up in the Plover Configuration Plugins UI, but before enabling it, follow the remaining setup steps outlined in the README file, particularly around setting up the OP_SERVICE_ACCOUNT_TOKEN environment variable (and you won't need to worry about the manual installation step for the 1Password Python SDK outlined there since you will have essentially already done it).

A new version of the Plover 1Password plugin will get released as soon as the 1Password Python SDK gets released to PyPI, which should result in the elimination of needing to manually install any dependencies.

paulfioravanti commented 1 month ago

1Password Python SDK is now on PyPI, and I've been able to confirm that, at least on my Windows machine, everything installs correctly using the now-released version 0.4.2 of this plugin.

So, I'm going to consider this closed, but happy to re-open if any plugin users on Windows are still seeing any installation issues.