pip-installable version of package sage_conf - installs non-Python bits of the Sage distribution in ~/.sage/ #29039

mkoeppe · 2020-01-18T17:34:51Z

As #30913 makes sage-conf both (a) a PEP517/518 build_system requires and (b) an install-requires of sagelib (sagemath-standard), also a version of sage-conf must be made available on PyPI.

This version of sage-conf includes a copy of SAGE_ROOT and SAGE_ROOT/build/** in its source distribution. On installation (or wheel building) it establishes a python-less SAGE_LOCAL hierarchy (#31362) in ~/.sage/ by running configure and make build-local; and then installs the configured sage_conf.py (#29038) as a Python module (and sage-config, sage-env-config).

There are no changes to how the Sage distribution is built. This ticket only provides an alternative and strictly optional way of installing (the non-Python bits of) Sage-the-distribution. It may be useful for some users who wish to use pip to install everything they need.

To test:

./bootstrap && (cd pkgs/sage-conf_pypi/ && tox -r -v -v -v)

This test using tox uses .sage in an isolated directory within .tox instead of in your home directory. At the end of the tox run, the installed sage-config script is executed; it prints the configuration variables:

[10639] /Users/mkoeppe/s/sage/sage-rebasing/worktree-algebraic-2018-spring/pkgs/sage-conf_pypi$ /Users/mkoeppe/s/sage/sage-rebasing/worktree-algebraic-2018-spring/pkgs/sage-conf-pypi/.tox/python/bin/sage-config
VERSION=9.3.beta7
MAXIMA=/Users/mkoeppe/s/sage/sage-rebasing/worktree-algebraic-2018-spring/src/pkgs/sage_conf-pypi/.tox/python/.sage/sage-9.3.beta7-cpython-39-darwin/local/bin/maxima
ARB_LIBRARY=arb
SAGE_NAUTY_BINS_PREFIX=
CBLAS_PC_MODULES=cblas
MATHJAX_DIR=/Users/mkoeppe/s/sage/sage-rebasing/worktree-algebraic-2018-spring/src/pkgs/sage_conf-pypi/.tox/python/.sage/sage-9.3.beta7-cpython-39-darwin/local/share/mathjax
THREEJS_DIR=/Users/mkoeppe/s/sage/sage-rebasing/worktree-algebraic-2018-spring/src/pkgs/sage_conf-pypi/.tox/python/.sage/sage-9.3.beta7-cpython-39-darwin/local/share/threejs
SAGE_LOCAL=/Users/mkoeppe/s/sage/sage-rebasing/worktree-algebraic-2018-spring/src/pkgs/sage_conf-pypi/.tox/python/.sage/sage-9.3.beta7-cpython-39-darwin/local
SAGE_ROOT=/Users/mkoeppe/s/sage/sage-rebasing/worktree-algebraic-2018-spring/src/pkgs/sage_conf-pypi/.tox/python/.sage/sage-9.3.beta7-cpython-39-darwin
python finish: run-test  after 0.17 seconds

To build a source distribution:

./sage -sh -c build/pkgs/sage_conf/spkg-src

(The source distribution has been uploaded to https://pypi.org/project/sage-conf/)

Follow-up steps:

Make SAGE_ROOT configurable by the user (by passing --prefix to setup.py).
Optionally, it would create a venv that is used for building wheels.
sage-conf_pypi: API for incremental builds #30036: Make the build more incremental: On installation of sage-conf, only run configure but do not install anything; rather, a Python entry point can be used by Python distribution packages such as sagemath-standard to install packages if present.

CC: @jhpalmieri @dimpase @kiwifb @vbraun

Component: build

Keywords: sd111

Author: Matthias Koeppe

Branch: 2a4a323

Reviewer: Dima Pasechnik, François Bissey

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

The text was updated successfully, but these errors were encountered:

mkoeppe · 2020-06-29T20:13:40Z

Dependencies: #30025

mkoeppe · 2020-06-29T21:34:54Z

Branch: u/mkoeppe/pip_installable_package_sage_bootstrap

mkoeppe · 2020-06-29T22:16:31Z

New commits:

`6e28ae5`	`Add sage_root to sage_bootstrap`

mkoeppe · 2020-06-29T22:16:31Z

Commit: 6e28ae5

sagetrac-git · 2020-06-30T01:02:08Z

Changed commit from 6e28ae5 to a6373b7

sagetrac-git · 2020-06-30T01:02:08Z

Branch pushed to git repo; I updated commit sha1. New commits:

`a6373b7`	`build/setup.py: Add sage_root as package_data`

sagetrac-git · 2020-07-01T03:45:29Z

Changed commit from a6373b7 to b0ddab0

sagetrac-git · 2020-07-01T03:45:29Z

Branch pushed to git repo; I updated commit sha1. New commits:

`441cb6e`	`Working sdist and install`
`b0ddab0`	`Simplify directory structure`

mkoeppe · 2020-07-01T05:34:28Z

Changed dependencies from #30025 to #30025, #29850

sagetrac-git · 2020-07-01T06:42:57Z

Changed commit from b0ddab0 to 60642d3

sagetrac-git · 2020-07-01T06:42:57Z

Branch pushed to git repo; I updated commit sha1. New commits:

`10f4fbe`	`build/setup.py: Reuse configured sage root`
`733427c`	`Re-add build/sage_root`
`60642d3`	`build/setup.py: Install sage_conf.py, sage-env-config`

mkoeppe · 2020-07-01T06:46:47Z

Changed dependencies from #30025, #29850 to #30025

sagetrac-git · 2020-07-03T06:13:37Z

Branch pushed to git repo; I updated commit sha1. New commits:

`8006b6f`	`Add sage_bootstrap.build`

sagetrac-git · 2020-07-03T06:13:37Z

Changed commit from 60642d3 to 8006b6f

mkoeppe · 2020-07-03T06:14:46Z

Work Issues: sage-system-python in installed sage_bootstrap

sagetrac-git · 2021-10-29T07:17:27Z

Branch pushed to git repo; I updated commit sha1. New commits:

`cebcda3`	`Merge tag '9.5.beta4' into t/29039/pip_installable_package_sage_bootstrap`
`0026892`	`Merge tag '9.5.beta5' into t/29039/pip_installable_package_sage_bootstrap`

sagetrac-git · 2021-10-29T07:17:27Z

Changed commit from c695921 to 0026892

mkoeppe · 2021-11-12T06:08:57Z

comment:155

Still waiting for review

kiwifb · 2021-11-12T06:29:20Z

comment:156

Right, let's move this forward, it needs a fair bit of bot-testing.

kiwifb · 2021-11-12T06:29:20Z

Changed reviewer from Dima Pasechnik, ... to Dima Pasechnik, François Bissey

mkoeppe · 2021-11-12T20:41:13Z

comment:157

Thanks.

Note that that we currently do not have automatic testing for this by bots or GH Actions.
There are a number of open tickets: #32703, #32570, #32113, #30845 that need attention

sagetrac-git · 2021-11-19T00:41:48Z

Branch pushed to git repo; I updated commit sha1 and set ticket back to needs_review. New commits:

`2a4a323`	`Merge tag '9.5.beta7' into t/29039/pip_installable_package_sage_bootstrap`

sagetrac-git · 2021-11-19T00:41:48Z

Changed commit from 0026892 to 2a4a323

jhpalmieri · 2021-12-03T20:35:08Z

comment:160

Replying to @mkoeppe:

Note that make distclean does not clean stuff in .tox, so if you want to start from scratch, use tox -r

Should make distclean clean stuff in .tox? Running tox -r might have helped with a problem at https://ask.sagemath.org/question/60029/sage-not-installing-from-source.

mkoeppe · 2021-12-03T20:55:09Z

comment:161

It shouldn't (because .tox is not an artifact of the normal build that is orchestrated by "make"), and this user's problems have nothing to do with tox

mkoeppe · 2021-12-19T19:33:56Z

comment:162

Release script seems to have skipped this ticket

vbraun · 2021-12-28T21:20:18Z

Changed dependencies from #32442 to none

vbraun · 2021-12-28T21:20:18Z

comment:163

This ticket depends on a ticket that has no attached branch, hence it'll never be merged

mkoeppe · 2021-12-28T21:22:08Z

comment:164

Thanks

vbraun · 2021-12-29T21:43:11Z

Changed branch from u/mkoeppe/pip_installable_package_sage_bootstrap to 2a4a323

mkoeppe · 2022-01-01T19:52:06Z

Changed commit from 2a4a323 to none

mkoeppe · 2022-01-01T19:52:06Z

comment:166

Replying to @kiwifb:

A little bit late at this stage to ask for stuff but here it goes. Would it be appropriate to split the file sage_conf.py into two parts?

One that would keep the name and contains the main function and doesn't need to be configured, and the second one that just contains the variables and that would be pre-parsed by configure.

The idea being that distro could just provide/configure the second file has they see fit without touching the functionality of the package.

Done now in #31396. Happy new year!

mkoeppe added this to the sage-9.1 milestone Jan 18, 2020

mkoeppe added c: build labels Jan 18, 2020

This comment has been minimized.

Sign in to view

mkoeppe removed this from the sage-9.1 milestone Jan 30, 2020

mkoeppe added the wishlist item label Jan 30, 2020

This comment has been minimized.

Sign in to view

mkoeppe added this to the sage-9.3 milestone Jun 28, 2020

mkoeppe removed the wishlist item label Jun 28, 2020

mkoeppe changed the title ~~Package sage_local~~ pip-installable package sage_bootstrap Jun 28, 2020

This comment has been minimized.

Sign in to view

mkoeppe added the s: needs review label Sep 28, 2021

This comment has been minimized.

Sign in to view

kiwifb added s: positive review and removed s: needs review labels Nov 12, 2021

sagetrac-git mannequin added s: needs review and removed s: positive review labels Nov 19, 2021

mkoeppe added s: positive review and removed s: needs review labels Nov 19, 2021

vbraun removed the s: positive review label Dec 29, 2021

vbraun closed this as completed in bd2a837 Dec 29, 2021

embray mentioned this issue Jun 13, 2021

Add an autoconf configure script for sagelib #29119

Closed

tobiasdiez mentioned this issue Jan 1, 2022

Add version constraints for sage-conf, clean the sage-conf sdist #32904

Closed

mkoeppe added a commit to mkoeppe/sage that referenced this issue Feb 17, 2023

Merge sagemath#29039

30da94c

pip-installable version of package sage_conf - installs non-Python bits of the Sage distribution in ~/.sage/ #29039

pip-installable version of package sage_conf - installs non-Python bits of the Sage distribution in ~/.sage/ #29039

Comments

mkoeppe commented Jan 18, 2020

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

mkoeppe commented Jun 29, 2020

This comment has been minimized.

mkoeppe commented Jun 29, 2020

mkoeppe commented Jun 29, 2020

mkoeppe commented Jun 29, 2020

This comment has been minimized.

sagetrac-git mannequin commented Jun 30, 2020

sagetrac-git mannequin commented Jun 30, 2020

sagetrac-git mannequin commented Jul 1, 2020

sagetrac-git mannequin commented Jul 1, 2020

mkoeppe commented Jul 1, 2020

sagetrac-git mannequin commented Jul 1, 2020

sagetrac-git mannequin commented Jul 1, 2020

This comment has been minimized.

mkoeppe commented Jul 1, 2020

sagetrac-git mannequin commented Jul 3, 2020

sagetrac-git mannequin commented Jul 3, 2020

mkoeppe commented Jul 3, 2020

This comment has been minimized.

sagetrac-git mannequin commented Oct 29, 2021

sagetrac-git mannequin commented Oct 29, 2021

mkoeppe commented Nov 12, 2021

kiwifb commented Nov 12, 2021

kiwifb commented Nov 12, 2021

mkoeppe commented Nov 12, 2021

sagetrac-git mannequin commented Nov 19, 2021

sagetrac-git mannequin commented Nov 19, 2021

jhpalmieri commented Dec 3, 2021

mkoeppe commented Dec 3, 2021

mkoeppe commented Dec 19, 2021

vbraun commented Dec 28, 2021

vbraun commented Dec 28, 2021

mkoeppe commented Dec 28, 2021

vbraun commented Dec 29, 2021

mkoeppe commented Jan 1, 2022

mkoeppe commented Jan 1, 2022