Skip to content

Commit

Permalink
src/doc/en/developer/packaging.rst: 'sage --package create --pypi' no…
Browse files Browse the repository at this point in the history
…w generates dependencies for wheels
  • Loading branch information
mkoeppe committed Apr 1, 2024
1 parent 4f89448 commit 9008916
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions src/doc/en/developer/packaging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1075,22 +1075,27 @@ from PyPI and also obtains most of the necessary information by querying PyPI.
In particular, the ``SPKG.rst`` file is created as a copy of the package's
README file.
The ``dependencies`` file may need editing (watch out for warnings regarding
``--no-deps`` that Sage issues during installation of the package!).
By default, when the package is available as a platform-independent
wheel, the ``sage --package`` creates a ``wheel`` package. In this case,
the ``dependencies`` file is automatically generated from the information
on PyPI, but may still need some manual editing.
For ``normal`` and ``pip`` packages, the ``dependencies`` file is initialized
to the bare minimum and will need manual editing. (Watch out for warnings
regarding ``--no-deps`` that Sage issues during installation of the package!).
Also you may want to set lower and upper bounds for acceptable package versions
in the file ``install-requires.txt``. (Make sure that the version in
``package-version.txt`` falls within this acceptable version range!)
By default, when the package is available as a platform-independent
wheel, the ``sage --package`` creates a wheel package. To create a normal package
instead (for example, when the package requires patching), you can use::
To create a ``normal`` package instead of a ``wheel`` package (for example, when the
package requires patching), you can use::
[alice@localhost sage]$ ./sage --package create pkg:pypi/scikit-spatial \
--source normal \
--type optional
To create a pip package rather than a normal or wheel package, you can use::
To create a ``pip`` package rather than a ``normal`` or ``wheel`` package, you can use::
[alice@localhost sage]$ ./sage --package create pkg:pypi/scikit-spatial \
--source pip \
Expand Down

0 comments on commit 9008916

Please sign in to comment.