plover.dev-with-plugins: init #119702

evils · 2021-04-17T12:17:00Z

based on / closes #110658
closes #89341

Motivation for this change

help some community members

Things done

remaining issues (help wanted)

plugins don't work in a nix-shell
upstream recommendations (don't use the patch, use dist_main entry point) break things

evils · 2021-04-17T12:42:40Z

pkgs/applications/misc/plover/default.nix

+      sha256 = "1q4y3dl0p1yz9q2jb6hkhdskhbci7bfwgs5fvm8i09r011j0bghr";
+    };
+
+    patches = [ ./plugins_manager.patch ];


without the patch plugins can't be managed

evils · 2021-04-17T12:44:13Z

pkgs/applications/misc/plover/default.nix

@@ -46,6 +46,11 @@ rec {
      sha256 = "0kf27ykw6cjlpyr47nqad5hvpc1sza8x4lpnprwksd70y9hjs40g";
    };

+    # upstream recommendation
+    postPatch = ''
+      sed -i 's/^\(\s*plover = plover.\)main:main$/\1dist_main:main/' setup.cfg


with this change plover still works in a nix-shell
but fails to start in my environment

pkgs/development/python-modules/requests-futures/default.nix

switch to fetchFromGitHub and correct license

This reverts commit 3a6ac8e6d351e966baaf40a5ce573b0d7fd79238. this change prevents starting in my user environment (still works in a pure shell)

without it: Error while finding module specification for 'plover_plugins_manager.pip_wrapper' (ModuleNotFoundError: No module named 'plover_plugins_manager')

SuperSandro2000 · 2021-06-01T07:33:13Z

pkgs/applications/misc/plover/default.nix

+    src = fetchFromGitHub {
+      owner = "openstenoproject";
+      repo = "plover";
+      rev = "54dbcf4ea73cc1ecc1d7c70dbe7bdb13f055d101";


Suggested change

rev = "54dbcf4ea73cc1ecc1d7c70dbe7bdb13f055d101";

rev = "v${version}";

nope, they're doing a moving tag of "continuous" but still have a versioning scheme that's no longer integrated with git

SuperSandro2000 · 2021-06-01T07:34:57Z

pkgs/development/python-modules/requests-futures/default.nix

+
+buildPythonPackage rec {
+  pname = "requests-futures";
+  version = "0.9.9-27-gf126048";


From where did you get the version number?

git describe --tags minus the leading v

lambdadog · 2021-08-11T17:35:54Z

pkgs/applications/misc/plover/default.nix

+    };
+  };
+
+  dev-with-plugins = dev.overrideAttrs (old: {


I can only echo my thoughts on #110658 that including the plugin manager is expected functionality with the dev branch of plover. It's what you'll get if you're installing plover dev with any other package manager, or the appimage, or whatever else.

If anything, now that my experience with Nix has grown, I'd like to see an argument that can be overridden (to false) on plover dev that enables the package manager by default, rather than creating two separate derivations that are built, something like

plover.dev.override { withPluginManager = false; }

Actually, thinking further, I'm not exactly happy that the plugin-manager derivation is exposed as it is either.

While there is the potential usecase that one would want to override the plugin manager, the way it's currently exposed gives no particularly elegant ability to do so (other than simply repeating your plover-with-plugins derivation wholesale). It shouldn't be exposed in the plover tree's top level as it currently is. My best image for how it should be exposed while giving a way to override it probably looks like putting it under a subtree like plover.devPlugins.plugin-manager, then plover.dev could expose, perhaps, both a withPluginManager and plugins override argument. If you wanted to swap out the plugin manager with an overridden version, you would set withPluginManager to false, then add your overridden version to plugins.

I'm more than happy for more brainstorming on the subject, though, I admit this probably isn't the most elegant solution but I think we need to deal with a couple of concerns, including:

the plugin-manager being included being an expected default

allowing users to disable it if they wish

making the plover subtree not bloated, and

considering the possibility of extending plover with a withPlugins-like functionality in the future, which this is already great groundwork for

the right solution™ is probably to accept a list of plugins
then the (default) setting of an empty list would not provide the plugin manager

as far as i know this would require packaging all the plugins in nixpkgs
which i'm not willing to do because plover doesn't work on wayland...

for now, setting plover.dev to include the plugin manager does seem like the right way forward

unfortunately i seem to recall the issue with this PR being,
plover not reliably finding the site packages (plugins) installed by the plugin manager
(between a nix-env install, a nix-shell, and a NixOS systemPackages install)
which is something i don't know how to fix, but would like to see fixed before seeing this PR merged
alternatively, we could merge something that works in 1 use-case and let users get annoyed enough to fix it themselves

You could probably see if it's possible to pass the site packages in an environmental variable?

It would need to be the same place recognized by the plugin manager and writeable though, but the only two cases I see are:

executed by a user with a $HOME directory, and

executed by a user without a $HOME directory (which, frankly, given the use-case of plover may not be a problem in the first place)

This can be done with makeWrapper using the --run flag and a '-quoted argument to it using $HOME, you can see how my emacs config using Nix does similar here

I imagine something like (assuming the variable needed is SITE_PACKAGES and both the plugin manager and plover would read from it correctly)

makeWrapper "PATH/TO/PLOVER/EXECUTABLE" "$out/bin/plover" --run 'mkdir -p "$HOME/PATH/TO/YOUR/SITEPACKAGES"' --run 'export SITE_PACKAGES="$HOME/PATH/TO/YOUR/SITEPACKAGES"'

would work.

Of course, you would also need the site packages that nixpkgs' buildPythonPackage creates, but I'm sure it's possible to do with a bit of work.

At worst you could probably do some patching of plover and the plugin manager here or there to enable it.

Upon research you may be interested in the PYTHONUSERBASE environmental variable, which I don't believe that buildPythonPackage co-opts for its own usage.

stale · 2022-04-18T18:16:00Z

I marked this as stale due to inactivity. → More info

github-actions bot added the 6.topic: python label Apr 17, 2021

ofborg bot added the 8.has: package (new) label Apr 17, 2021

ofborg bot requested a review from KoviRobi April 17, 2021 12:26

ofborg bot added 10.rebuild-darwin: 1-10 10.rebuild-linux: 1-10 labels Apr 17, 2021

evils commented Apr 17, 2021

View reviewed changes

SuperSandro2000 requested changes Apr 17, 2021

View reviewed changes

evils force-pushed the plover branch from 5400bfe to 2bab10e Compare April 17, 2021 14:56

evils added 8 commits April 22, 2021 23:57

plover.dev: dev8 -> dev9

e9e1dc1

switch to fetchFromGitHub and correct license

python3.pkgs.requests-futures: init at v4.0.0.dev8+402.g9f1027f

b846d83

plover.plugins-manager: init at 0.6.1

1c92776

plover.dev-with-plugins: init

afe2082

plover.dev: remove unneeded postPatch

e56884f

plover.dev: change python entry point

eadec59

Revert "plover.dev: change python entry point"

98e65e3

This reverts commit 3a6ac8e6d351e966baaf40a5ce573b0d7fd79238. this change prevents starting in my user environment (still works in a pure shell)

plover.plugins-manager: add patch back in

125ef20

without it: Error while finding module specification for 'plover_plugins_manager.pip_wrapper' (ModuleNotFoundError: No module named 'plover_plugins_manager')

evils force-pushed the plover branch from 2bab10e to 125ef20 Compare April 26, 2021 02:58

SuperSandro2000 reviewed Jun 1, 2021

View reviewed changes

lambdadog mentioned this pull request Aug 11, 2021

Add Plover plugins #89341

Open

lambdadog reviewed Aug 11, 2021

View reviewed changes

stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Apr 18, 2022

wegank added the 2.status: merge conflict label Mar 20, 2024

stale bot removed the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Mar 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

plover.dev-with-plugins: init #119702

plover.dev-with-plugins: init #119702

evils commented Apr 17, 2021 •

edited

evils Apr 17, 2021

evils Apr 17, 2021

SuperSandro2000 Jun 1, 2021

evils Jun 1, 2021

SuperSandro2000 Jun 1, 2021

evils Jun 1, 2021 •

edited

lambdadog Aug 11, 2021 •

edited

lambdadog Aug 11, 2021 •

edited

evils Aug 12, 2021

lambdadog Aug 17, 2021

lambdadog Aug 17, 2021

lambdadog Aug 17, 2021

lambdadog Aug 17, 2021 •

edited

stale bot commented Apr 18, 2022

	rev = "54dbcf4ea73cc1ecc1d7c70dbe7bdb13f055d101";
	rev = "v${version}";

plover.dev-with-plugins: init #119702

Are you sure you want to change the base?

plover.dev-with-plugins: init #119702

Conversation

evils commented Apr 17, 2021 • edited

Motivation for this change

Things done

remaining issues (help wanted)

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

evils Jun 1, 2021 • edited

Choose a reason for hiding this comment

lambdadog Aug 11, 2021 • edited

Choose a reason for hiding this comment

lambdadog Aug 11, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lambdadog Aug 17, 2021 • edited

Choose a reason for hiding this comment

stale bot commented Apr 18, 2022

evils commented Apr 17, 2021 •

edited

evils Jun 1, 2021 •

edited

lambdadog Aug 11, 2021 •

edited

lambdadog Aug 11, 2021 •

edited

lambdadog Aug 17, 2021 •

edited