nb: init at 5.7.8 #110962

toonn · 2021-01-27T21:35:46Z

Motivation for this change

Seemed like an interesting note-taking application to package.

Things done

SuperSandro2000 · 2021-01-27T21:41:12Z

pkgs/applications/misc/nb/default.nix

+    sha256 = "1sw09sgskzsn3dy4ipvl52hwh5k3cwqfhjnm7rmxbzcpfk3jm3sp";
+  };
+
+  buildInputs = [ bash git ];


How is git used here? If it is used to extract version or commit information from the repository this would require patching.

The script uses git to synchronize your notes. So at runtime, not buildtime.

Shouldn't makeWrapper be used for such things?

pkgs/applications/misc/nb/default.nix

stale · 2021-08-04T22:42:54Z

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

auroraanna

Are you gonna finish this? I would like to test this program.

auroraanna · 2022-04-16T23:54:38Z

pkgs/applications/misc/nb/default.nix

+, bash, git
+}:
+stdenv.mkDerivation rec {
+  version = "5.7.8";


Suggested change

version = "5.7.8";

version = "6.10.1";

I don't currently have time to. The script is enormous and somewhat messy and this interacts poorly with wrapping. I'm mostly hoping resholve becomes advanced enough to deal with it automatically.

auroraanna · 2022-04-24T00:27:46Z

pkgs/applications/misc/nb/default.nix

+{ stdenv, lib, fetchFromGitHub, installShellFiles
+, bash, git
+}:
+stdenv.mkDerivation rec {
+  version = "5.7.8";
+  pname = "nb";
+
+  src = fetchFromGitHub {
+    owner = "xwmx";
+    repo = "nb";
+    rev = version;
+    sha256 = "1sw09sgskzsn3dy4ipvl52hwh5k3cwqfhjnm7rmxbzcpfk3jm3sp";
+  };
+
+  buildInputs = [ bash git ];
+  nativeBuildInputs = [ installShellFiles ];
+
+  dontBuild = true;
+
+  installPhase = ''
+    mkdir -p $out/bin/
+    mv nb $out/bin/
+    mv bin/bookmark $out/bin/
+
+    runHook postInstall
+  '';
+
+  postInstall = ''
+    installShellCompletion etc/nb-completion.{bash,zsh}
+  '';
+
+  meta = with lib; {
+    description = "A command line note-taking, bookmarking, archiving, and knowledge base application";
+    longDescription = ''
+      `nb` creates notes in text-based formats like Markdown, Emacs Org mode,
+      and LaTeX, can work with files in any format, can import and export notes
+      to many document formats, and can create private, password-protected
+      encrypted notes and bookmarks. With `nb`, you can write notes using Vim,
+      Emacs, VS Code, Sublime Text, and any other text editor you like. `nb`
+      works in any standard Linux / Unix environment, including macOS and
+      Windows via WSL. Optional dependencies can be installed to enhance
+      functionality, but `nb` works great without them.
+
+      `nb` is also a powerful text-based CLI bookmarking system. Page
+      information is automatically downloaded, compiled, and saved into normal
+      Markdown documents made for humans, so bookmarks are easy to edit just
+      like any other note.
+
+      `nb` uses Git in the background to automatically record changes and sync
+      notebooks with remote repositories. `nb` can also be configured to sync
+      notebooks using a general purpose syncing utility like Dropbox so notes
+      can be edited in other apps on any device.
+
+      `nb` is designed to be portable, future-focused, and vendor independent,
+      providing a full-featured and intuitive experience within a highly
+      composable user-centric text interface. The entire program is a single
+      well-tested shell script that can be installed, copied, or curled almost
+      anywhere and just work, using progressive enhancement for various
+      experience improvements in more capable environments. `nb` works great
+      whether you have one notebook with just a few notes or dozens of
+      notebooks containing thousands of notes, bookmarks, and other items. `nb`
+      makes it easy to incorporate other tools, writing apps, and workflows.
+      `nb` can be used a little, a lot, once in a while, or for just a subset
+      of features. `nb` is flexible.
+    '';
+    homepage = "https://xwmx.github.io/nb/";
+    license = licenses.agpl3Plus;
+    maintainers = [ maintainers.toonn ];
+    platforms = platforms.all;
+  };
+}


Suggested change

{ stdenv, lib, fetchFromGitHub, installShellFiles

, bash, git

}:

stdenv.mkDerivation rec {

version = "5.7.8";

pname = "nb";

src = fetchFromGitHub {

owner = "xwmx";

repo = "nb";

rev = version;

sha256 = "1sw09sgskzsn3dy4ipvl52hwh5k3cwqfhjnm7rmxbzcpfk3jm3sp";

};

buildInputs = [ bash git ];

nativeBuildInputs = [ installShellFiles ];

dontBuild = true;

installPhase = ''

mkdir -p $out/bin/

mv nb $out/bin/

mv bin/bookmark $out/bin/

runHook postInstall

'';

postInstall = ''

installShellCompletion etc/nb-completion.{bash,zsh}

'';

meta = with lib; {

description = "A command line note-taking, bookmarking, archiving, and knowledge base application";

longDescription = ''

`nb` creates notes in text-based formats like Markdown, Emacs Org mode,

and LaTeX, can work with files in any format, can import and export notes

to many document formats, and can create private, password-protected

encrypted notes and bookmarks. With `nb`, you can write notes using Vim,

Emacs, VS Code, Sublime Text, and any other text editor you like. `nb`

works in any standard Linux / Unix environment, including macOS and

Windows via WSL. Optional dependencies can be installed to enhance

functionality, but `nb` works great without them.

`nb` is also a powerful text-based CLI bookmarking system. Page

information is automatically downloaded, compiled, and saved into normal

Markdown documents made for humans, so bookmarks are easy to edit just

like any other note.

`nb` uses Git in the background to automatically record changes and sync

notebooks with remote repositories. `nb` can also be configured to sync

notebooks using a general purpose syncing utility like Dropbox so notes

can be edited in other apps on any device.

`nb` is designed to be portable, future-focused, and vendor independent,

providing a full-featured and intuitive experience within a highly

composable user-centric text interface. The entire program is a single

well-tested shell script that can be installed, copied, or curled almost

anywhere and just work, using progressive enhancement for various

experience improvements in more capable environments. `nb` works great

whether you have one notebook with just a few notes or dozens of

notebooks containing thousands of notes, bookmarks, and other items. `nb`

makes it easy to incorporate other tools, writing apps, and workflows.

`nb` can be used a little, a lot, once in a while, or for just a subset

of features. `nb` is flexible.

'';

homepage = "https://xwmx.github.io/nb/";

license = licenses.agpl3Plus;

maintainers = [ maintainers.toonn ];

platforms = platforms.all;

};

}

{ stdenv

, lib

, fetchFromGitHub

, makeWrapper

, installShellFiles

, bash

, git

}:

stdenv.mkDerivation rec {

version = "6.10.2";

pname = "nb";

src = fetchFromGitHub {

owner = "xwmx";

repo = "nb";

rev = version;

sha256 = "sha256-n87NT+qzBq8J1n0aT2Di7iBEN9inDWXAb8c7Qd2y0TA=";

};

nativeBuildInputs = [ makeWrapper installShellFiles ];

dontBuild = true;

postPatch = ''

patchShebangs ./nb ./bin/bookmark

'';

installPhase = ''

mkdir -p $out/bin

mv nb $out/bin/

mv bin/bookmark $out/bin/

wrapProgram $out/bin/nb --prefix PATH : "${lib.makeBinPath [

bash

git

]}"

runHook postInstall

'';

postInstall = ''

installShellCompletion etc/nb-completion.{bash,zsh}

'';

meta = with lib; {

description = "A command line note-taking, bookmarking, archiving, and knowledge base application";

longDescription = ''

`nb` creates notes in text-based formats like Markdown, Emacs Org mode,

and LaTeX, can work with files in any format, can import and export notes

to many document formats, and can create private, password-protected

encrypted notes and bookmarks. With `nb`, you can write notes using Vim,

Emacs, VS Code, Sublime Text, and any other text editor you like. `nb`

works in any standard Linux / Unix environment, including macOS and

Windows via WSL. Optional dependencies can be installed to enhance

functionality, but `nb` works great without them.

`nb` is also a powerful text-based CLI bookmarking system. Page

information is automatically downloaded, compiled, and saved into normal

Markdown documents made for humans, so bookmarks are easy to edit just

like any other note.

`nb` uses Git in the background to automatically record changes and sync

notebooks with remote repositories. `nb` can also be configured to sync

notebooks using a general purpose syncing utility like Dropbox so notes

can be edited in other apps on any device.

`nb` is designed to be portable, future-focused, and vendor independent,

providing a full-featured and intuitive experience within a highly

composable user-centric text interface. The entire program is a single

well-tested shell script that can be installed, copied, or curled almost

anywhere and just work, using progressive enhancement for various

experience improvements in more capable environments. `nb` works great

whether you have one notebook with just a few notes or dozens of

notebooks containing thousands of notes, bookmarks, and other items. `nb`

makes it easy to incorporate other tools, writing apps, and workflows.

`nb` can be used a little, a lot, once in a while, or for just a subset

of features. `nb` is flexible.

'';

homepage = "https://xwmx.github.io/nb/";

license = licenses.agpl3Plus;

maintainers = with maintainers; [ toonn ];

platforms = platforms.all;

};

}

I tried to make the wrapProgram function work for both nb and bookmark with a for statement but that didn't work. Is there another way than just cloning it for bookmark?

Also, should be optional dependencies be included here or not?

Do we need to wrap it separately? I think you can invoke it as a subcommand and it's a pretty generic name to claim.

I'm not really sure about the optional deps. They were atrociously badly documented when I last looked into this, most weren't actually mentioned anywhere in the docs. They're not build-time dependencies and nb simply picks them up from the environment if they're present so I don't think we should burden ourselves maintaining a potentially volatile list of deps.

I removed the optional deps.

auroraanna · 2022-04-24T00:31:41Z

You also need to add an entry in pkgs/top-level/all-packages.nix.

Co-authored-by: papojari <papojari-git.ovoid@aleeas.com>

pkgs/tools/misc/nb/default.nix

toonn · 2022-05-13T09:14:37Z

Ah, unfortunate that this was merged. I had picked this back up, figured there was no rush since it's been so long anyway. The current state of the package means it's pretty much unusable.

It's a very annoying script to package because it's supposed to pick things up from the PATH but in my testing that didn't work properly. It doesn't manage to pick up VISUAL nor EDITOR for example so I couldn't add notes. Simply wrapping it isn't straightforward because what editor should we wrap it with? Wrapping also messes up all the help messages because nb tries to be smart about it and use the name it was executed with everywhere, hence getting .nb-wrapped everywhere in the help and that command isn't actually on the PATH so it all becomes a bit confusing.

auroraanna · 2022-05-14T13:02:27Z

Then we must patch the source code so that it doesn't display .nb-wrapped.

toonn · 2022-05-17T18:35:59Z

That's an option but also a moving target. I was hoping we could find a way to wrap it such that that's not necessary. I think we could simply embed the PATH that ends up in the wrapper at the top of the script instead. But the problem remains that wrapping means explicitly specifying dependencies and that means we need to figure out all of the dependencies, which aren't actually documented and are not all obvious at first glance when reading/searching the script.

SuperSandro2000 reviewed Jan 27, 2021

View reviewed changes

SuperSandro2000 requested changes Jan 27, 2021

View reviewed changes

pkgs/applications/misc/nb/default.nix Outdated Show resolved Hide resolved

ofborg bot added 10.rebuild-darwin: 0 10.rebuild-linux: 0 labels Jan 27, 2021

sikmir reviewed Feb 5, 2021

View reviewed changes

pkgs/applications/misc/nb/default.nix Outdated Show resolved Hide resolved

stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Aug 4, 2021

auroraanna suggested changes Apr 16, 2022

View reviewed changes

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

auroraanna suggested changes Apr 24, 2022

View reviewed changes

toonn and others added 6 commits May 12, 2022 17:04

nb: init at 5.7.8

0065423

nb: Run postInstall hook

255ed22

nb: Add to top-level/all-packages

6a44472

nb: 5.7.8 -> 6.10.1

25d6e23

Co-authored-by: papojari <papojari-git.ovoid@aleeas.com>

nb: Drop run-time dependencies from buildInputs

92fe28e

nb: Drop bookmark alias

e04d8ab

toonn force-pushed the nb branch from 4caa38f to e04d8ab Compare May 12, 2022 15:06

ofborg bot added 8.has: package (new) 11.by: package-maintainer 10.rebuild-darwin: 1-10 10.rebuild-darwin: 1 10.rebuild-linux: 1-10 10.rebuild-linux: 1 and removed 10.rebuild-darwin: 0 10.rebuild-linux: 0 labels May 12, 2022

SuperSandro2000 reviewed May 12, 2022

View reviewed changes

pkgs/tools/misc/nb/default.nix Outdated Show resolved Hide resolved

SuperSandro2000 reviewed May 12, 2022

View reviewed changes

pkgs/tools/misc/nb/default.nix Outdated Show resolved Hide resolved

Apply suggestions from code review

a53cddf

SuperSandro2000 merged commit 44414b4 into NixOS:master May 12, 2022

uninsane mentioned this pull request Jul 23, 2022

Package request: nb #151138

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

nb: init at 5.7.8 #110962

nb: init at 5.7.8 #110962

toonn commented Jan 27, 2021

SuperSandro2000 Jan 27, 2021

toonn Jan 27, 2021

SuperSandro2000 Jan 27, 2021

stale bot commented Aug 4, 2021

auroraanna left a comment

auroraanna Apr 16, 2022

toonn Apr 22, 2022 •

edited

auroraanna Apr 24, 2022 •

edited

auroraanna Apr 24, 2022

auroraanna Apr 24, 2022

toonn Apr 25, 2022

auroraanna Apr 26, 2022

auroraanna commented Apr 24, 2022

toonn commented May 13, 2022

auroraanna commented May 14, 2022

toonn commented May 17, 2022

nb: init at 5.7.8 #110962

nb: init at 5.7.8 #110962

Conversation

toonn commented Jan 27, 2021

Motivation for this change

Things done

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stale bot commented Aug 4, 2021

auroraanna left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

toonn Apr 22, 2022 • edited

Choose a reason for hiding this comment

auroraanna Apr 24, 2022 • 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

auroraanna commented Apr 24, 2022

toonn commented May 13, 2022

auroraanna commented May 14, 2022

toonn commented May 17, 2022

toonn Apr 22, 2022 •

edited

auroraanna Apr 24, 2022 •

edited