Developer's guide: Add section on modularization

[mkoeppe]

We add a section to the developer manual, explaining packaging portions of the Sage library to distributions packages.

Related discussion in the sage devel:

https://groups.google.com/g/sage-devel/c/cTifWZOAfH8

See also: #32925 Improve documentation of sage.features

CC: @kwankyu @dimpase @tobiasdiez

Component: documentation

Author: Matthias Koeppe, Kwankyu Lee

Branch/Commit: b555735

Reviewer: Kwankyu Lee, Matthias Koeppe

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

[mkoeppe]

Branch: u/mkoeppe/developer_s_guide__add_section_on_modularization

[sagetrac-git]

Commit: f85959b

[sagetrac-git]

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

f85959b

README.md: Update section Directory Layout

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

2494538	src/doc/en/developer/packaging.rst: Update section 'Python-based packages'
0327ca8	README.md: Update section Directory Layout
1d3a470	src/doc/en/developer/python_packaging.rst: New

[sagetrac-git]

Changed commit from f85959b to 1d3a470

[sagetrac-git]

Changed commit from 1d3a470 to 7606c55

[sagetrac-git]

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

7606c55

src/doc/en/developer/python_packaging.rst: Document distribution package source layout

[sagetrac-git]

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

70da678

src/doc/en/developer/python_packaging.rst: Document dependencies

[sagetrac-git]

Changed commit from 7606c55 to 70da678

[sagetrac-git]

Changed commit from 70da678 to 3f80c6e

[sagetrac-git]

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

3f80c6e

src/doc/en/developer/python_packaging.rst: Version constraints

[mkoeppe]

Author: Matthias Koeppe

[mkoeppe]

comment:7

More to come in a follow-up ticket

[sagetrac-git]

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

190ee43

src/doc/en/developer/python_packaging.rst: Add section on testing

[sagetrac-git]

Changed commit from 3f80c6e to 190ee43

[sagetrac-git]

Changed commit from 190ee43 to 8da48f2

[sagetrac-git]

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

8da48f2

src/doc/en/developer/python_packaging.rst: More on dependencies

[sagetrac-git]

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

5f99b19

src/doc/en/developer/python_packaging.rst: Namespace packages

[sagetrac-git]

Changed commit from 8da48f2 to 5f99b19

[sagetrac-git]

Changed commit from 5f99b19 to c7e56f6

[sagetrac-git]

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

c7e56f6

src/doc/en/developer/python_packaging.rst: Explain monorepo

[sagetrac-git]

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

9a7096e	src/doc/en/developer/python_packaging.rst: Explain symlinks
ba0e4a8	src/doc/en/developer/python_packaging.rst: Policy for distribution names

[sagetrac-git]

Changed commit from c7e56f6 to ba0e4a8

[sagetrac-git]

Changed commit from ba0e4a8 to 6c97779

[sagetrac-git]

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

6c97779

src/doc/en/developer/python_packaging.rst: Add remarks on reducing dependencies

[mkoeppe]

comment:49

Thanks very much, this is a great improvement.

[sagetrac-git]

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

7d6a44c

Use :mod: as markup for packages/modules

[sagetrac-git]

Changed commit from c6fc111 to 7d6a44c

[sagetrac-git]

Changed commit from 7d6a44c to f83d424

[sagetrac-git]

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

f83d424

Improve ABC example

[sagetrac-git]

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

817a8d0

src/doc/en/developer/packaging_sage_library.rst: More :mod: and :class: markup

[sagetrac-git]

Changed commit from f83d424 to 817a8d0

[sagetrac-git]

Changed commit from 817a8d0 to b555735

[sagetrac-git]

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

b555735

src/doc/en/developer/packaging_sage_library.rst: Link to pypi.org and to documentation of packaging metadata

[kwankyu]

comment:55

I am positive on the branch. Let's wait for green light.

[kwankyu]

comment:56

Perhaps the patchbot failure is not genuine, but I will double check it.

Meanwhile, I have a question. Is it too late to name the distribution packages as sagelib-xxx? I think this name suggests that the distribution provides a portion of the sage library, which is true. Also in pkgs/, I see both distribution packages with names sage-xxx and sagemath-xxx. Here sagemath does not tell the difference between sage- packages and sagemath- packages.

[mkoeppe]

comment:57

The distributions named sage-... use the package/module name: sage-setup distributes sage_setup, sage-conf distributes sage_conf etc.

Overall the name "sage" is heavily overloaded, on PyPI you see a number of completely unrelated packages. Using "sagelib" would not help with that.

"sagemath" is sufficiently specific.

[kwankyu]

comment:58

I am okay with the branch. The patchbot failures are not genuine.

You can set it positive review if you are okay too.

[mkoeppe]

comment:59

Thanks for the review and your contributions!

[vbraun]

Changed branch from public/32899 to b555735