python3Packages.dash: init at 1.8.0 #77837

antoinerg · 2020-01-16T17:50:30Z

Motivation for this change

Dash is an open-source framework that creates analytical web apps from Python without writing a single line of javascript (https://dash.plot.ly/). It would be awesome to package it in NixOS!

Things done

Manual test

I tested that I could start a simple Dash app:

$ nix-shell -I nixpkgs=$(pwd) -p python3Packages.dash
$ python app.py

smaret · 2020-01-16T21:29:05Z

nix-review pr passes on macOS.

jonringer

there should roughly be a commit per package addition

jonringer · 2020-01-16T23:11:13Z

pkgs/development/python-modules/dash-core-components/default.nix

+  pname = "dash-core-components";
+  version = "1.7.0";
+
+  src = fetchurl {


There's already a helper for this, see https://github.com/NixOS/nixpkgs/blob/211ed174657712a00fd3bcabd590d2e7b7a25e10/pkgs/development/python-modules/requests/default.nix for an example

Suggested change

src = fetchurl {

src = fetchPypi {

@jonringer I initially gave up on fetchPypi because it wasn't working for me. I just realized it's because the package name should have underscores instead of dashes. It's now fixed for all packages in 4f0952022dcd5314aa6b56a98901155110c3294a.

antoinerg

there should roughly be a commit per package addition

~~@jonringer I'm sorry, I wasn't aware of that. Can I rebase and force push with a proper commit log?~~ Ok so I force pushed a cleaned up commit log to fit that requirement.

jonringer

Please add tests (checkout from the github repos is preferable to no tets)
Please add yourself as a maintainer
Please apply comments to all packages

closes #69110

jonringer · 2020-01-17T20:04:44Z

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

+  doCheck = false;
+
+  meta = {
+    description = "Dash is a Python framework for building analytical web applications. No JavaScript required.";


don't need to define the subject, we know it's the description of a given package. "No JavaScript required." is just click-baity

Suggested change

description = "Dash is a Python framework for building analytical web applications. No JavaScript required.";

description = "Python framework for building analytical web applications";

Fixed in 411a351

jonringer · 2020-01-17T20:05:04Z

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

+  meta = {
+    description = "Dash is a Python framework for building analytical web applications. No JavaScript required.";
+    homepage = https://dash.plot.ly/;
+    license = with lib.licenses; [ mit ];


needs other suggestion to work

Suggested change

license = with lib.licenses; [ mit ];

license = licenses.mit;

Done in 411a351

jonringer · 2020-01-17T20:05:38Z

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

+  # No tests in archive
+  doCheck = false;
+
+  meta = {


also useful for referencing maintainers

Suggested change

meta = {

meta = with lib; {

Thanks! Done in 411a351

antoinerg · 2020-01-17T20:39:13Z

Please add tests (checkout from the github repos is preferable to no tets)

I am sorry to be such a newbie but can you expand on this @jonringer? Would the following be enough?

  # in lieu of proper tests
  pythonImportsCheck = [
    "dash"
  ];

Thank you for your patience

jonringer · 2020-01-17T21:44:08Z

pythonImportsCheck will essentially do python -c 'import $MODULE_PATH' for each item. This will catch stuff such as namespace issues or some missing dependency issues. It's to give a little more validity that the package would be able to work in a normal workflow.

EDIT: However, unit tests are a much better measure to ensure the packages are internally correct and usable.

antoinerg · 2020-01-17T21:45:16Z

pythonImportsCheck will essentially do python -c 'import $MODULE_PATH for each item. This will catch stuff such as namespace issues or some missing dependency issues. It's to give a little more validity that the package would be able to work in a normal workflow.

So I take it it would be good enough?

jonringer · 2020-01-17T21:45:58Z

I am sorry to be such a newbie

I was a newbie at nix not too long ago as well. No reason to apologize :)

jonringer · 2020-01-17T21:48:43Z

The big push for tests is to ensure that a bunch of packages aren't subtly broken. Since the sources are available through github, it's preferred to use from source rather just have our fingers crossed.

This becomes more important when we have to alter upstream version bounds, having tests ensures that we have valid packages, even if upstream isn't testing against those dependency ranges.

jonringer

for the add antoinerg as maintainer of python3Packages.dash-* commit, do you mind just doing:

  antoinerg = {
    email = "roygobeil.antoine@gmail.com";
    github = "antoinerg";
    githubId = 301546;
    name = "Antoine Roy-Gobeil";
  };

as maintainers: add antoinerg

then adding yourself to the other packages can remain as another commit.

Generally maintainer additions are separate from package changes.

Not sure how strong your git-fu is, let me know if you need help with altering git history. (but i would look at how to use git rebase -i if you're not already familiar)

antoinerg · 2020-01-20T16:03:14Z

EDIT: However, unit tests are a much better measure to ensure the packages are internally correct and usable.

With 9cd2e23, it now runs a few unit tests. I skipped the ones that require browsers. All those tests are run upstream prior to a release. I hope this is good enough @jonringer !

jonringer · 2020-01-21T02:20:51Z

please squash the dash fixup commit into the other.

git rebase -i HEAD~4
# move `python3Packages.dash: pull from github instead of pypi, run unit tests` line below dash init commit
# make `pick -> squash` for python3Packages.dash: pull from github instead of pypi, run unit tests
# save

git push --force

otherwise LGTM

antoinerg · 2020-01-21T03:12:58Z

please squash the dash fixup commit into the other.

git rebase -i HEAD~4
# move `python3Packages.dash: pull from github instead of pypi, run unit tests` line below dash init commit
# make `pick -> squash` for python3Packages.dash: pull from github instead of pypi, run unit tests
# save

git push --force

otherwise LGTM

Now done @jonringer !

jonringer

diff LGTM

[21 built, 36 copied (194.3 MiB), 12.9 MiB DL]
https://github.com/NixOS/nixpkgs/pull/77837
15 package built:
python27Packages.dash python27Packages.dash-core-components python27Packages.dash-html-components python27Packages.dash-renderer python27Packages.dash-table python37Packages.dash python37Packages.dash-core-components python37Packages.dash-html-components python37Packages.dash-renderer python37Packages.dash-table python38Packages.dash python38Packages.dash-core-components python38Packages.dash-html-components python38Packages.dash-renderer python38Packages.dash-table

jonringer · 2020-01-21T20:17:43Z

@GrahamcOfBorg build python27Packages.dash python27Packages.dash-core-components python27Packages.dash-html-components python27Packages.dash-renderer python27Packages.dash-table python37Packages.dash python37Packages.dash-core-components python37Packages.dash-html-components python37Packages.dash-renderer python37Packages.dash-table python38Packages.dash python38Packages.dash-core-components python38Packages.dash-html-components python38Packages.dash-renderer python38Packages.dash-table

antoinerg requested review from FRidh and jonringer as code owners January 16, 2020 17:50

ofborg bot added 6.topic: python 8.has: package (new) 10.rebuild-darwin: 11-100 10.rebuild-linux: 11-100 labels Jan 16, 2020

jonringer reviewed Jan 16, 2020

View reviewed changes

antoinerg commented Jan 17, 2020

View reviewed changes

antoinerg added 4 commits January 17, 2020 13:24

python3Packages.dash-core-components: init at 1.7.0

e9b05cf

python3Packages.dash-html-components: init at 1.0.2

e9a5669

python3Packages.dash-renderer: init at 1.2.3

8b18240

python3Packages.dash-core-components: init at 4.6.0

aacf963

jonringer reviewed Jan 17, 2020

View reviewed changes

ofborg bot added the 11.by: package-maintainer label Jan 17, 2020

jonringer reviewed Jan 17, 2020

View reviewed changes

antoinerg added 3 commits January 20, 2020 22:10

python3Packages.dash: init at 1.8.0

33609d1

maintainers: add antoinerg

012cb44

add antoinerg as maintainer of python3Packages.dash-*

fdb2d97

antoinerg requested a review from jonringer January 21, 2020 20:04

jonringer approved these changes Jan 21, 2020

View reviewed changes

jonringer merged commit a8c36db into NixOS:master Jan 21, 2020

antoinerg deleted the python3-dash branch January 21, 2020 20:36

t184256 mentioned this pull request Jan 30, 2020

pythonPackages.dash: init at 1.3.0 #69110

Closed

10 tasks

Janik-Haag added the 12. first-time contribution label Jun 12, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

python3Packages.dash: init at 1.8.0 #77837

python3Packages.dash: init at 1.8.0 #77837

antoinerg commented Jan 16, 2020 •

edited

smaret commented Jan 16, 2020

jonringer left a comment

jonringer Jan 16, 2020

antoinerg Jan 17, 2020

antoinerg left a comment •

edited

jonringer left a comment

jonringer Jan 17, 2020

antoinerg Jan 17, 2020

jonringer Jan 17, 2020

antoinerg Jan 17, 2020

jonringer Jan 17, 2020

antoinerg Jan 17, 2020

antoinerg commented Jan 17, 2020

jonringer commented Jan 17, 2020 •

edited

antoinerg commented Jan 17, 2020

jonringer commented Jan 17, 2020

jonringer commented Jan 17, 2020

jonringer left a comment •

edited

antoinerg commented Jan 20, 2020

jonringer commented Jan 21, 2020 •

edited

antoinerg commented Jan 21, 2020

jonringer left a comment

jonringer commented Jan 21, 2020

	description = "Dash is a Python framework for building analytical web applications. No JavaScript required.";
	description = "Python framework for building analytical web applications";

	license = with lib.licenses; [ mit ];
	license = licenses.mit;

python3Packages.dash: init at 1.8.0 #77837

python3Packages.dash: init at 1.8.0 #77837

Conversation

antoinerg commented Jan 16, 2020 • edited

Motivation for this change

Things done

Manual test

smaret commented Jan 16, 2020

jonringer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

antoinerg left a comment • edited

Choose a reason for hiding this comment

jonringer left a 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

Choose a reason for hiding this comment

antoinerg commented Jan 17, 2020

jonringer commented Jan 17, 2020 • edited

antoinerg commented Jan 17, 2020

jonringer commented Jan 17, 2020

jonringer commented Jan 17, 2020

jonringer left a comment • edited

Choose a reason for hiding this comment

antoinerg commented Jan 20, 2020

jonringer commented Jan 21, 2020 • edited

antoinerg commented Jan 21, 2020

jonringer left a comment

Choose a reason for hiding this comment

jonringer commented Jan 21, 2020

antoinerg commented Jan 16, 2020 •

edited

antoinerg left a comment •

edited

jonringer commented Jan 17, 2020 •

edited

jonringer left a comment •

edited

jonringer commented Jan 21, 2020 •

edited