Make SageNB use setuptools instead of distutils

[TimDumol]

Currently, SageNB makes use of distutils. The standard method of package distribution, though, is setuptools. This has several advantages, the foremost being a setup.py develop command, which bypasses the need to reinstall the package in order to propagate a change, as well as the ability to upload the package to PyPI with a single command. There is also additional functionality regards packaging, etc.

CC: @qed777 @williamstein

Component: notebook

Author: Tim Dumol

Reviewer: Mitesh Patel

Issue created by migration from https://trac.sagemath.org/ticket/7467

[TimDumol]

comment:1

This should do it.

[TimDumol]

Attachment: trac_7467-setuptools.patch.gz

Makes setup.py use setuptools instead of distutils. Depends on #7402 for things to work properly.

[TimDumol]

Attachment: trac_7467-setuptools.2.patch.gz

Added necessary .hgignore lines.

[qed777]

Author: Tim Dumol

[qed777]

comment:2

What are your thoughts about

• On packaging
• A Few Corrections To “On Packaging”

? I found these links at Tools of the Modern Python Hacker: Virtualenv, Fabric and Pip.

[TimDumol]

comment:3

Replying to @qed777:

What are your thoughts about

• On packaging
• A Few Corrections To “On Packaging”

? I found these links at Tools of the Modern Python Hacker: Virtualenv, Fabric and Pip.

These tools are orthogonal to usage of setuptools, to note.

I personally make use of Virtualenv and Pip all the time for deployment. They're very useful for keeping one's site-packages clean.

[qed777]

comment:4

Thanks for the clarification. What if we use pip (i.e., pip.py) as SageNB's installer? The uninstall facility might allow us to select among different development versions (and their requirements) in a clean way. Currently, extraneous files can "accumulate" in site-packages/sagenb until I do rm -rf and reinstall.

Disclaimer: I'm not familiar with distutils, pip, or setuptools.

On #7447: Can we query the installed version of a package with setuptools and/or pip?

[TimDumol]

comment:5

Replying to @qed777:

[...]
On #7447: Can we query the installed version of a package with setuptools and/or pip?

I believe something like this should do the trick:

from pkg_resources import Requirement, working_set
version = working_set.find9Requirement.parse('sagenb')).version

[TimDumol]

comment:6

Replying to @TimDumol:

Replying to @qed777:

[...]
On #7447: Can we query the installed version of a package with setuptools and/or pip?

I believe something like this should do the trick:

from pkg_resources import Requirement, working_set
version = working_set.find9Requirement.parse('sagenb')).version

Sorry, I meant working_set.find(Requirement.parse('sagenb')).version

[TimDumol]

comment:7

Replying to @qed777:

Thanks for the clarification. What if we use pip (i.e., pip.py) as SageNB's installer? The uninstall facility might allow us to select among different development versions (and their requirements) in a clean way. Currently, extraneous files can "accumulate" in site-packages/sagenb until I do rm -rf and reinstall.
[..]

Wow, that feature's new. I don't see why not, although it would mean adding another package to Sage.

[qed777]

comment:8

I get

sage: from pkg_resources import Requirement, working_set
sage: working_set.find(Requirement.parse('sagenb')).version
AttributeError: 'NoneType' object has no attribute 'version'

On using pip: We could just add pip.py, according to this.

[TimDumol]

comment:9

Replying to @qed777:

I get

sage: from pkg_resources import Requirement, working_set
sage: working_set.find(Requirement.parse('sagenb')).version
AttributeError: 'NoneType' object has no attribute 'version'

On using pip: We could just add pip.py, according to this.

I believe detection of version using pkg_resources requires it be installed by setuptools, i.e., this patch.

[qed777]

comment:10

OK, or pip, I suppose. Thanks. I'll put a note at #7447.

[qed777]

comment:11

Although I'm not very familar with distutils or setuptools, this works for and looks good to me. A spkg built with spkg-dist installs properly. Moreover, we can query the sagenb version just as indicated in the comments above.

[qed777]

Reviewer: Mitesh Patel

[williamstein]

comment:13

+1!