termtosvg: init at 0.3.0 #43069

Ma27 · 2018-07-05T13:04:40Z

Motivation for this change

termtosvg makes screencasts and writes them into a SVG file. The app
can be used on CLI entirely.

Closes #42921

Things done

Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS)
Built on platform(s)
- NixOS
- macOS
- other Linux distributions
Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
Tested compilation of all pkgs that depend on this change using nix-shell -p nox --run "nox-review wip"
Tested execution of all binary files (usually in ./result/bin/)
Determined the impact on package closure size (by running nix path-info -S before and after)
Fits CONTRIBUTING.md.

Ma27 · 2018-07-05T13:05:16Z

/cc @Jumblemuddle

adisbladis · 2018-07-05T14:46:29Z

This doesn't look like a library and does not belong in pythonPackages.
./pkgs/tools/misc/ is probably the correct location.

xeji · 2018-07-05T21:43:39Z

pkgs/development/python-modules/termtosvg/default.nix

@@ -0,0 +1,29 @@
+{ lib, buildPythonPackage, fetchFromGitHub, svgwrite, pyte, mock, unittest2, isPy3k }:
+
+buildPythonPackage rec {


Since it's a standalone app, buildPythonApplication fits better.

xeji · 2018-07-05T21:53:59Z

pkgs/development/python-modules/termtosvg/default.nix

+  version = "0.3.0";
+
+  # tests broken on Python 2, standalone app that should be fine with Python 3
+  disable = !isPy3k;


If you use buildPythonApplication above, you can use python3 as input and get rid of this.

dotlambda · 2018-07-05T23:21:33Z

pkgs/tools/misc/termtosvg/default.nix

+  postCheck = "unset HOME";
+
+  meta = with lib; {
+    homepage = https://pypi.org/project/termtosvg/;


This should be https://github.com/nbedos/termtosvg and the description is missing.

dotlambda · 2018-07-05T23:22:35Z

pkgs/tools/misc/termtosvg/default.nix

@@ -0,0 +1,26 @@
+{ lib, buildPythonApplication, fetchFromGitHub, svgwrite, pyte, mock, unittest2 }:


Please pass only lib, python3 and fetchFromGitHub as arguments so that the Python package set can be easily overriden.

dotlambda · 2018-07-05T23:22:44Z

pkgs/top-level/all-packages.nix

@@ -18413,6 +18413,10 @@ with pkgs;
    vte = gnome3.vte-ng;
  };

+  termtosvg = callPackage ../tools/misc/termtosvg {
+    inherit (python3Packages) buildPythonApplication svgwrite pyte mock unittest2;


Drop this line.

dotlambda

Don't forget to remove the python3Packages prefix from your commit message.

Ma27 · 2018-07-05T23:35:32Z

ack, will work through the review %)

Ma27 · 2018-07-05T23:47:51Z

ok, this history looks wrong %)

adisbladis · 2018-07-06T05:55:57Z

pkgs/top-level/all-packages.nix

@@ -18413,6 +18413,8 @@ with pkgs;
    vte = gnome3.vte-ng;
  };

+  termtosvg = callPackage ../tools/misc/termtosvg { };


Use python3Packages.callPackage and list all packages as input to the function instead.
You can look at aws_shell for an example.

I thought that callPackage is fine in this case if I understand threads like this correctly: #38028 (comment)

Yeah you are right. Sorry for the noise.

xeji · 2018-07-06T09:13:50Z

Please remove the debootstrap commit and fix eval (missing meta.homepage).

`termtosvg` makes screencasts and writes them into a SVG file. The app can be used on CLI entirely. Closes NixOS#42921

xeji · 2018-07-06T12:09:31Z

@GrahamcOfBorg build termtosvg

GrahamcOfBorg · 2018-07-06T12:10:06Z

Success on x86_64-darwin (full log)

Attempted: termtosvg

Partial log (click to expand)

test__record (tests.test_term.TestTerm) ... ok
test_get_terminal_size (tests.test_term.TestTerm) ... ok
test_record (tests.test_term.TestTerm) ... ok
test_replay (tests.test_term.TestTerm) ... ok

----------------------------------------------------------------------
Ran 19 tests in 4.648s

OK
/nix/store/0jvhs4mhw7gqrs9hzazqmh5mpbw3mz3s-termtosvg-0.3.0

GrahamcOfBorg · 2018-07-06T12:10:22Z

Success on x86_64-linux (full log)

Attempted: termtosvg

Partial log (click to expand)

Recording started, enter "exit" command or Control-D to end
Recording ended, SVG animation is /build/termtosvg_cv24fc9l.svg
ok
test_parse (tests.test___main__.TestMain) ... ok

----------------------------------------------------------------------
Ran 19 tests in 6.270s

OK
/nix/store/dal1168wq2mkanr04ldn4k88ql3s2mm4-termtosvg-0.3.0

GrahamcOfBorg · 2018-07-06T12:10:28Z

Success on aarch64-linux (full log)

Attempted: termtosvg

Partial log (click to expand)

Recording started, enter "exit" command or Control-D to end
Recording ended, SVG animation is /build/termtosvg_33je_f2j.svg
ok
test_parse (tests.test___main__.TestMain) ... ok

----------------------------------------------------------------------
Ran 19 tests in 7.272s

OK
/nix/store/0qshvmmmj1d5brc9ycrq91qknvqd2p2i-termtosvg-0.3.0

xeji · 2018-07-06T12:13:18Z

Don't forget to remove the python3Packages prefix from your commit message.

Done in the merge.

Ma27 requested a review from FRidh as a code owner July 5, 2018 13:04

GrahamcOfBorg added 6.topic: python 8.has: package (new) 10.rebuild-darwin: 1-10 10.rebuild-linux: 1-10 labels Jul 5, 2018

xeji reviewed Jul 5, 2018

View reviewed changes

Ma27 force-pushed the package-termtosvg branch from ec3b7c1 to b063e5c Compare July 5, 2018 22:25

GrahamcOfBorg removed the 6.topic: python label Jul 5, 2018

dotlambda requested changes Jul 5, 2018

View reviewed changes

Ma27 changed the title ~~python3Packages.termtosvg: init at 0.3.0~~ termtosvg: init at 0.3.0 Jul 5, 2018

Ma27 force-pushed the package-termtosvg branch from b063e5c to ff95f8b Compare July 5, 2018 23:41

Ma27 force-pushed the package-termtosvg branch from ff95f8b to 97918cf Compare July 5, 2018 23:49

adisbladis reviewed Jul 6, 2018

View reviewed changes

python3Packages.termtosvg: init at 0.3.0

c48437a

`termtosvg` makes screencasts and writes them into a SVG file. The app can be used on CLI entirely. Closes NixOS#42921

Ma27 force-pushed the package-termtosvg branch from 97918cf to c48437a Compare July 6, 2018 11:34

xeji approved these changes Jul 6, 2018

View reviewed changes

xeji merged commit e331236 into NixOS:master Jul 6, 2018

Ma27 deleted the package-termtosvg branch July 6, 2018 12:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

termtosvg: init at 0.3.0 #43069

termtosvg: init at 0.3.0 #43069

Ma27 commented Jul 5, 2018 •

edited

Ma27 commented Jul 5, 2018

adisbladis commented Jul 5, 2018

xeji Jul 5, 2018

xeji Jul 5, 2018

dotlambda Jul 5, 2018

dotlambda Jul 5, 2018

dotlambda Jul 5, 2018

dotlambda left a comment

Ma27 commented Jul 5, 2018

Ma27 commented Jul 5, 2018

adisbladis Jul 6, 2018

Ma27 Jul 6, 2018

adisbladis Jul 6, 2018

xeji commented Jul 6, 2018

xeji commented Jul 6, 2018

GrahamcOfBorg commented Jul 6, 2018

GrahamcOfBorg commented Jul 6, 2018

GrahamcOfBorg commented Jul 6, 2018

xeji commented Jul 6, 2018

		@@ -0,0 +1,29 @@
		{ lib, buildPythonPackage, fetchFromGitHub, svgwrite, pyte, mock, unittest2, isPy3k }:

		buildPythonPackage rec {

		@@ -0,0 +1,26 @@
		{ lib, buildPythonApplication, fetchFromGitHub, svgwrite, pyte, mock, unittest2 }:

termtosvg: init at 0.3.0 #43069

termtosvg: init at 0.3.0 #43069

Conversation

Ma27 commented Jul 5, 2018 • edited

Motivation for this change

Things done

Ma27 commented Jul 5, 2018

adisbladis commented Jul 5, 2018

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

dotlambda left a comment

Choose a reason for hiding this comment

Ma27 commented Jul 5, 2018

Ma27 commented Jul 5, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xeji commented Jul 6, 2018

xeji commented Jul 6, 2018

GrahamcOfBorg commented Jul 6, 2018

GrahamcOfBorg commented Jul 6, 2018

GrahamcOfBorg commented Jul 6, 2018

xeji commented Jul 6, 2018

Ma27 commented Jul 5, 2018 •

edited