diff options
| author | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2022-06-14 15:24:57 +0100 |
|---|---|---|
| committer | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2022-06-14 15:24:57 +0100 |
| commit | ddcfdfa9db21161af1ce3259ad63a148f3dc3242 (patch) | |
| tree | a5775f8b08f7bbfa85ff467d0ee28d110d47fb3b /docs/deprecated | |
| parent | 1b694edd1885488e586b87fb0b4dcca5b5ec2cc6 (diff) | |
| download | python-setuptools-git-ddcfdfa9db21161af1ce3259ad63a148f3dc3242.tar.gz | |
Add remark about install command
Diffstat (limited to 'docs/deprecated')
| -rw-r--r-- | docs/deprecated/commands.rst | 17 |
1 files changed, 15 insertions, 2 deletions
diff --git a/docs/deprecated/commands.rst b/docs/deprecated/commands.rst index 89acef85..e287ab8f 100644 --- a/docs/deprecated/commands.rst +++ b/docs/deprecated/commands.rst @@ -24,8 +24,11 @@ You could also run commands in other circumstances: That is, you can simply list the normal setup commands and options following the quoted part. .. warning:: - On recent versions of ``setuptools`` running commands via ``python setup.py`` - is considered **deprecated** (and should be avoided). + While it is perfectly fine that users write ``setup.py`` files to configure + a package build (e.g. to specify binary extensions or customize commands), + on recent versions of ``setuptools``, running ``python setup.py`` directly + as a script is considered **deprecated**. This also means that users should + avoid running commands directly via ``python setup.py <command>``. If you want to create :term:`sdist <Source Distribution (or "sdist")>` or :term:`wheel` distributions the recommendation is to use the command line tool provided by :pypi:`build`:: @@ -41,6 +44,16 @@ That is, you can simply list the normal setup commands and options following the ``setuptools``, by setting the :doc:`build requirements in pyproject.toml </build_meta>`. + If you want to install a package, you can use :pypi:`pip` or :pypi:`installer`:: + + pip install /path/to/wheel/file.whl + pip install /path/to/sdist/file.tar.gz + pip install . # replacement for python setup.py install + pip install --editable . # replacement for python setup.py develop + + pip install installer # nees to be installed first + python -m installer /path/to/wheel/file.whl + ----------------- Command Reference ----------------- |
