Differences between revisions 6 and 10 (spanning 4 versions)
Revision 6 as of 2020-10-31 22:38:24
Size: 1107
Editor: mkoeppe
Comment: update metatickets
Revision 10 as of 2020-12-28 19:52:15
Size: 4296
Editor: mkoeppe
Comment: more install-requires.txt
Deletions are marked like this. Additions are marked like this.
Line 6: Line 6:

== Package upgrades, system packages ==

=== FLINT, Arb ===

=== GAP ===

=== Other package upgrades ===

=== System package information for OpenSUSE ===

In particular, users of OpenSUSE Tumbleweed will notice the information about system packages that the Sage distribution can use.

=== For developers and packagers: Version constraints for Python packages ===

For all Python packages in the Sage distribution, `build/pkgs/SPKG/install-requires.txt` now encodes version constraints (such as lower and upper bounds) [[https://trac.sagemath.org/ticket/30719|#30719]].
The constraints are in the format of the `install_requires` key of [[https://setuptools.readthedocs.io/en/latest/userguide/declarative_config.html|setup.cfg]] or [[https://packaging.python.org/discussions/install-requires-vs-requirements/#id5|setup.py]].

The files may include comments (starting with `#`) that explain why a particular lower bound is warranted or why we wish to include or reject certain versions.
For example:
{{{
$ cat build/pkgs/sphinx/package-version.txt
3.1.2.p0
$ cat build/pkgs/sphinx/install-requires.txt
# gentoo uses 3.2.1
sphinx >=3, <3.3
}}}
The comments may include links to Trac tickets, as in the following example:
{{{
$ cat build/pkgs/packaging/install-requires.txt
packaging >=18.0
# Trac #30975: packaging 20.5 is known to work but we have to silence "DeprecationWarning: Creating a LegacyVersion"
}}}
The currently encoded version constraints are merely a starting point.
Downstream packagers and developers are invited to refine the version constraints based on their experience and tests. When a package update is made in order to pick up a critical bug fix from a newer version, then the lower bound should be adjusted.

In Sage 9.3, the new files are included only for documentation purposes and to facilitate development and packaging. An effort is underway in [[https://trac.sagemath.org/ticket/30913|#30913]] to use the new files to generate dependency metadata for the Sage library.
There is no mechanism yet to use system Python packages; see [[https://trac.sagemath.org/ticket/29023|Meta-ticket #29013]] for this task.

=== For developers: Setting up Python packages from PyPI as Sage packages ===

Setting up Python packages from PyPI as Sage packages has become easier [[https://trac.sagemath.org/ticket/30974|#30974]].
{{{
$ ./sage -package create scikit_spatial --pypi
Downloading tarball to /Users/mkoeppe/s/sage/sage-rebasing/worktree-algebraic-2018-spring/upstream/scikit-spatial-5.0.0.tar.gz
[......................................................................]
$ ls build/pkgs/scikit_spatial/
SPKG.rst dependencies package-version.txt type
checksums.ini install-requires.txt spkg-install.in
$ cat build/pkgs/scikit_spatial/SPKG.rst
scikit_spatial
==============

Description
-----------

Spatial objects and computations based on NumPy arrays.

License
-------

BSD license

Upstream Contact
----------------

https://pypi.org/project/scikit-spatial/
}}}

Note that this new command does not check the dependencies of the Python package; this still needs to be done manually.

Sage 9.3 Release Tour

in progress (2020)

Package upgrades, system packages

FLINT, Arb

GAP

Other package upgrades

System package information for OpenSUSE

In particular, users of OpenSUSE Tumbleweed will notice the information about system packages that the Sage distribution can use.

For developers and packagers: Version constraints for Python packages

For all Python packages in the Sage distribution, build/pkgs/SPKG/install-requires.txt now encodes version constraints (such as lower and upper bounds) #30719. The constraints are in the format of the install_requires key of setup.cfg or setup.py.

The files may include comments (starting with #) that explain why a particular lower bound is warranted or why we wish to include or reject certain versions. For example:

$ cat build/pkgs/sphinx/package-version.txt 
3.1.2.p0
$ cat build/pkgs/sphinx/install-requires.txt
# gentoo uses 3.2.1
sphinx >=3, <3.3

The comments may include links to Trac tickets, as in the following example:

$ cat build/pkgs/packaging/install-requires.txt
packaging >=18.0
# Trac #30975: packaging 20.5 is known to work but we have to silence "DeprecationWarning: Creating a LegacyVersion"

The currently encoded version constraints are merely a starting point. Downstream packagers and developers are invited to refine the version constraints based on their experience and tests. When a package update is made in order to pick up a critical bug fix from a newer version, then the lower bound should be adjusted.

In Sage 9.3, the new files are included only for documentation purposes and to facilitate development and packaging. An effort is underway in #30913 to use the new files to generate dependency metadata for the Sage library. There is no mechanism yet to use system Python packages; see Meta-ticket #29013 for this task.

For developers: Setting up Python packages from PyPI as Sage packages

Setting up Python packages from PyPI as Sage packages has become easier #30974.

$ ./sage -package create scikit_spatial --pypi
Downloading tarball to /Users/mkoeppe/s/sage/sage-rebasing/worktree-algebraic-2018-spring/upstream/scikit-spatial-5.0.0.tar.gz
[......................................................................]
$ ls build/pkgs/scikit_spatial/
SPKG.rst                dependencies            package-version.txt     type
checksums.ini           install-requires.txt    spkg-install.in
$ cat build/pkgs/scikit_spatial/SPKG.rst 
scikit_spatial
==============

Description
-----------

Spatial objects and computations based on NumPy arrays.

License
-------

BSD license

Upstream Contact
----------------

https://pypi.org/project/scikit-spatial/

Note that this new command does not check the dependencies of the Python package; this still needs to be done manually.

Modularization and packaging of sagelib

Use of system Jupyter notebook / JupyterLab

Tickets

Availability of Sage 9.3 and installation help

Development of the Sage 9.3 series has begun.