nixos/doc/gnome: Document how python nautilus extensions work #240780

doronbehar · 2023-06-30T18:54:58Z

Description of changes

Things done

nixos-discourse · 2023-06-30T18:55:11Z

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/nautilus-extension-not-working/12072/14

jtojnar · 2023-06-30T19:03:08Z

nixos/modules/services/x11/desktop-managers/gnome.md

+Some of these extensions, also include `gsettings` schemas, and adding them to `systemPackages` won't make them visible in `dconf-editor` or when you run `gsettings set`. An example of such an extension is yet again `nautilus-open-any-terminal`. Hence for this example, you have to add it in two places:
+
+```nix
+environment.systemPackages = with pkgs; [
+  gnome.nautilus-python
+  nautilus-open-any-terminal
+];
+services.xserver.desktopManager.gnome.extraGSettingsOverridePackages = with pkgs; [
+  nautilus-open-any-terminal
+];
+```


This should probably go to a separate section, as it is not specific to GNOME extensions. Though we will hopefully remove the option soon in favour of dconf module so perhaps it is not needed.

This should probably go to a separate section, as it is not specific to GNOME extensions.

Agree. I added that to the examples subsection.

Though we will hopefully remove the option soon in favour of dconf module so perhaps it is not needed.

Ideally :) But until then, let's document what is the current behavior...

jtojnar · 2023-06-30T19:06:38Z

nixos/modules/services/x11/desktop-managers/gnome.md

@@ -116,6 +116,37 @@ Unfortunately, we lack a way for these to be managed in a completely declarative
 So you have to enable them manually with an Extensions application.
 It is possible to use a [GSettings override](#sec-gnome-gsettings-overrides) for this on `org.gnome.shell.enabled-extensions`, but that will only influence the default value.

+## Nautilus Extensions {#sec-gnome-nautilus-extensions}
+
+Nautilus extensions can add additional functionality to Nautilus, usually via the right-click menu. Some of these extensions are dynamically loaded from `$NAUTILUS_4_EXTENSIONS_DIR` environment variable, which is automatically set if [](#opt-services.gnome.core-utilities.enable) is true (enabled by default if gnome is enabled).


The environment variable is an implementation detail so I am not sure we should expose it. Ideally, we would drop it in favour of Nautilus wrapper package.

I wonder if we should have a Nautilus module in the meanwhile.

The environment variable is an implementation detail so I am not sure we should expose it.

I won't mind if it won't be exposed, but I think it's nice to have this mentioned as this way users can ls -l $NAUTILUS_4_EXTENSIONS_DIR and see what extensions they have installed... Also, they can override that value with something else if they wish to.

I wonder if we should have a Nautilus module in the meanwhile.

Again, until then...

nixos/modules/services/x11/desktop-managers/gnome.md

jtojnar · 2023-06-30T19:10:33Z

nixos/modules/services/x11/desktop-managers/gnome.md

+];
+```
+
+In fact, any package that includes a python script at `/share/nautilus-python/extensions`, will provide a nautilus Python extension. Other examples include:


Maybe we should also have a nautilus-python module that adds this to pathsToLink.

That addition to pathsToLink is already made if services.gnome.core-utilities is enabled. Perhaps this behavior should be documented as well?

doronbehar

Thanks for the review @jtojnar. Regarding many of your comments that prospect about improving the module - I really think they are good ideas, but in the meantime the current behavior is not documented so maybe we can postpone them to a later time? Perhaps after this PR, users will read the current state of things and will consider improving the situation via a nautilus wrapper and a module, and dconf module.

doronbehar · 2023-06-30T20:45:14Z

nixos/modules/services/x11/desktop-managers/gnome.md

+];
+```
+
+In fact, any package that includes a python script at `/share/nautilus-python/extensions`, will provide a nautilus Python extension. Other examples include:


That addition to pathsToLink is already made if services.gnome.core-utilities is enabled. Perhaps this behavior should be documented as well?

nixos/modules/services/x11/desktop-managers/gnome.md

doronbehar · 2023-06-30T20:57:14Z

nixos/modules/services/x11/desktop-managers/gnome.md

+Some of these extensions, also include `gsettings` schemas, and adding them to `systemPackages` won't make them visible in `dconf-editor` or when you run `gsettings set`. An example of such an extension is yet again `nautilus-open-any-terminal`. Hence for this example, you have to add it in two places:
+
+```nix
+environment.systemPackages = with pkgs; [
+  gnome.nautilus-python
+  nautilus-open-any-terminal
+];
+services.xserver.desktopManager.gnome.extraGSettingsOverridePackages = with pkgs; [
+  nautilus-open-any-terminal
+];
+```


This should probably go to a separate section, as it is not specific to GNOME extensions.

Agree. I added that to the examples subsection.

Though we will hopefully remove the option soon in favour of dconf module so perhaps it is not needed.

Ideally :) But until then, let's document what is the current behavior...

nixos/modules/services/x11/desktop-managers/gnome.md

doronbehar · 2023-06-30T20:59:44Z

nixos/modules/services/x11/desktop-managers/gnome.md

@@ -116,6 +116,37 @@ Unfortunately, we lack a way for these to be managed in a completely declarative
 So you have to enable them manually with an Extensions application.
 It is possible to use a [GSettings override](#sec-gnome-gsettings-overrides) for this on `org.gnome.shell.enabled-extensions`, but that will only influence the default value.

+## Nautilus Extensions {#sec-gnome-nautilus-extensions}
+
+Nautilus extensions can add additional functionality to Nautilus, usually via the right-click menu. Some of these extensions are dynamically loaded from `$NAUTILUS_4_EXTENSIONS_DIR` environment variable, which is automatically set if [](#opt-services.gnome.core-utilities.enable) is true (enabled by default if gnome is enabled).


The environment variable is an implementation detail so I am not sure we should expose it.

I won't mind if it won't be exposed, but I think it's nice to have this mentioned as this way users can ls -l $NAUTILUS_4_EXTENSIONS_DIR and see what extensions they have installed... Also, they can override that value with something else if they wish to.

doronbehar · 2023-06-30T20:59:59Z

nixos/modules/services/x11/desktop-managers/gnome.md

@@ -116,6 +116,37 @@ Unfortunately, we lack a way for these to be managed in a completely declarative
 So you have to enable them manually with an Extensions application.
 It is possible to use a [GSettings override](#sec-gnome-gsettings-overrides) for this on `org.gnome.shell.enabled-extensions`, but that will only influence the default value.

+## Nautilus Extensions {#sec-gnome-nautilus-extensions}
+
+Nautilus extensions can add additional functionality to Nautilus, usually via the right-click menu. Some of these extensions are dynamically loaded from `$NAUTILUS_4_EXTENSIONS_DIR` environment variable, which is automatically set if [](#opt-services.gnome.core-utilities.enable) is true (enabled by default if gnome is enabled).


I wonder if we should have a Nautilus module in the meanwhile.

Again, until then...

doronbehar · 2023-07-23T14:51:20Z

Just fixed the phrasing of the commit title...

nixos-discourse · 2023-10-05T13:12:11Z

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/documenting-bugs-and-interfaces-worth-improving-in-nixpkgs-and-nixos/30884/4

nixos/modules/services/x11/desktop-managers/gnome.md

doronbehar requested a review from jtojnar June 30, 2023 18:54

github-actions bot added 6.topic: nixos 8.has: module (update) labels Jun 30, 2023

doronbehar force-pushed the doc/gnome-nautilus-extensions branch from 8b8f55a to 9c966ff Compare June 30, 2023 18:57

jtojnar reviewed Jun 30, 2023

View reviewed changes

ofborg bot added 10.rebuild-darwin: 0 10.rebuild-linux: 1-10 labels Jun 30, 2023

doronbehar commented Jun 30, 2023

View reviewed changes

doronbehar force-pushed the doc/gnome-nautilus-extensions branch from 9c966ff to bd9f6e6 Compare June 30, 2023 21:05

doronbehar changed the title ~~nixos/doc/gnome: Document how python nautilus extensions~~ nixos/doc/gnome: Document how python nautilus extensions work Jul 23, 2023

doronbehar force-pushed the doc/gnome-nautilus-extensions branch from bd9f6e6 to 2ba46e2 Compare July 23, 2023 14:49

doronbehar requested a review from jtojnar July 23, 2023 14:49

doronbehar added 8.has: documentation 6.topic: documentation Meta-discussion about documentation and its workflow labels Jul 28, 2023

dvonessen reviewed Nov 20, 2023

View reviewed changes

nixos/modules/services/x11/desktop-managers/gnome.md Outdated Show resolved Hide resolved

nixos/doc/gnome: Document how python nautilus extensions work

25905f2

doronbehar force-pushed the doc/gnome-nautilus-extensions branch from 2ba46e2 to 25905f2 Compare December 1, 2023 11:13

github-actions bot removed the 8.has: documentation label Dec 1, 2023

Thatoo mentioned this pull request Feb 15, 2024

gsconnect module install nautilus-python at the same time and make Firefox ready to work with its gsconnect extension snowfallorg/snowflakeos-modules#4

Open

wegank added the 2.status: merge conflict label Apr 5, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

nixos/doc/gnome: Document how python nautilus extensions work #240780

nixos/doc/gnome: Document how python nautilus extensions work #240780

doronbehar commented Jun 30, 2023

nixos-discourse commented Jun 30, 2023

jtojnar Jun 30, 2023

doronbehar Jun 30, 2023

jtojnar Jun 30, 2023

jtojnar Jun 30, 2023

doronbehar Jun 30, 2023

doronbehar Jun 30, 2023

jtojnar Jun 30, 2023

doronbehar Jun 30, 2023 •

edited

doronbehar left a comment

doronbehar Jun 30, 2023 •

edited

doronbehar Jun 30, 2023

doronbehar Jun 30, 2023

doronbehar Jun 30, 2023

doronbehar commented Jul 23, 2023

nixos-discourse commented Oct 5, 2023

nixos/doc/gnome: Document how python nautilus extensions work #240780

Are you sure you want to change the base?

nixos/doc/gnome: Document how python nautilus extensions work #240780

Conversation

doronbehar commented Jun 30, 2023

Description of changes

Things done

nixos-discourse commented Jun 30, 2023

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

doronbehar Jun 30, 2023 • edited

Choose a reason for hiding this comment

doronbehar left a comment

Choose a reason for hiding this comment

doronbehar Jun 30, 2023 • 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

doronbehar commented Jul 23, 2023

nixos-discourse commented Oct 5, 2023

doronbehar Jun 30, 2023 •

edited

doronbehar Jun 30, 2023 •

edited