Skip to content

Commit 86a7332

Browse files
authored
Merge pull request #2780 from bsipocz/doc_pip_install
DOC: use python -m pip
2 parents bbd3963 + c4894b9 commit 86a7332

File tree

4 files changed

+18
-18
lines changed

4 files changed

+18
-18
lines changed

README.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55,27 +55,27 @@ installed using `pip <https://pypi.python.org/pypi/pip>`_ or `anaconda
5555
<http://continuum.io/>`_. Running the tests requires `curl
5656
<https://curl.haxx.se/>`_ to be installed.
5757

58-
The latest version of astroquery can be pip installed (note the --pre for
59-
picking up released developer versions):
58+
The latest version of astroquery can be pip installed (note the ``--pre`` for
59+
picking up released developer versions, and ``-U`` for upgrade):
6060

6161
.. code-block:: bash
6262
63-
$ pip install --pre astroquery
63+
$ python -m pip install -U --pre astroquery
6464
6565
To install all the mandatory and optional dependencies add the ``[all]``
6666
identifyer to the pip command above (or use ``[docs]`` or ``[test]`` for the
6767
dependencies required to build the documentation or run the tests):
6868

6969
.. code-block:: bash
7070
71-
$ pip install --pre astroquery[all]
71+
$ python -m pip install -U --pre astroquery[all]
7272
7373
7474
To install the 'bleeding edge' version:
7575

7676
.. code-block:: bash
7777
78-
$ pip install git+https://github.com/astropy/astroquery.git
78+
$ python -m pip install git+https://github.com/astropy/astroquery.git
7979
8080
or cloned and installed from source:
8181

@@ -86,7 +86,7 @@ or cloned and installed from source:
8686
$ # If you do not:
8787
$ git clone https://github.com/astropy/astroquery.git
8888
$ cd astroquery
89-
$ pip install .
89+
$ python -m pip install .
9090
9191
Using astroquery
9292
----------------

docs/index.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,19 +32,19 @@ releases are automatically uploaded to `PyPI <https://pypi.org/project/astroquer
3232
and therefore the latest version of astroquery can be pip installed.
3333
The version number of these automated releases contain the ``'dev'`` tag, thus pip needs to be told
3434
to look for these releases during an upgrade, using the ``--pre`` install option. If astroquery is
35-
already installed, please make sure you use the ``--upgrade`` install option as well.
35+
already installed, please make sure you use the ``--upgrade`` (or ``-U``) install option as well.
3636

3737
.. code-block:: bash
3838
39-
$ pip install --pre astroquery
39+
$ python -m pip install -U --pre astroquery
4040
4141
To install all the mandatory and optional dependencies add the ``[all]``
4242
identifyer to the pip command above (or use ``[docs]`` or ``[test]`` for the
4343
dependencies required to build the documentation or run the tests):
4444

4545
.. code-block:: bash
4646
47-
$ pip install --pre astroquery[all]
47+
$ python -m pip install -U --pre astroquery[all]
4848
4949
In addition to the automated releases, we also keep doing regular, tagged version for maintenance
5050
and packaging purposes. These can be ``pip`` installed without the ``--pre`` option and
@@ -74,7 +74,7 @@ The development version can be obtained and installed from github:
7474
$ # If you do not:
7575
$ git clone https://github.com/astropy/astroquery.git
7676
$ cd astroquery
77-
$ pip install .
77+
$ python -m pip install .
7878
7979
8080
To install all the optional dependencies (listed below), add the option
@@ -89,7 +89,7 @@ building the documentation, in editable mode:
8989

9090
.. code-block:: bash
9191
92-
$ pip install -e .[all,test,docs]
92+
$ python -m pip install -e .[all,test,docs]
9393
9494
9595
Requirements
@@ -123,7 +123,7 @@ full functionality of the `~astroquery.mocserver` module:
123123
For the `~astroquery.vamdc` module:
124124

125125
* `vamdclib <https://github.com/VAMDC/vamdclib/>`_ install version from
126-
personal fork: ``pip install git+https://github.com/keflavich/vamdclib-1.git``
126+
personal fork: ``python -m pip install git+https://github.com/keflavich/vamdclib-1.git``
127127

128128
The following packages are optional dependencies and are required for the
129129
full functionality of the `~astroquery.mast` module:

docs/vamdc/vamdc.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Getting Started
1212
The astroquery vamdc interface requires vamdclib_. The documentation is sparse
1313
to nonexistent, but installation is straightforward::
1414

15-
pip install git+https://github.com/keflavich/vamdclib-1.git
15+
python -m pip install git+https://github.com/keflavich/vamdclib-1.git
1616

1717
This is the personal fork of the astroquery maintainer that includes astropy's
1818
setup helpers on top of the vamdclib infrastructure. If the infrastructure is

tox.ini

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,10 @@ extras =
4848

4949

5050
commands =
51-
devdeps: pip install -U --pre --only-binary :all: -i https://pypi.anaconda.org/scientific-python-nightly-wheels/simple numpy
52-
devdeps: pip install -U --pre -i https://pypi.anaconda.org/astropy/simple astropy
51+
devdeps: python -m pip install -U --pre --only-binary :all: -i https://pypi.anaconda.org/scientific-python-nightly-wheels/simple numpy
52+
devdeps: python -m pip install -U --pre -i https://pypi.anaconda.org/astropy/simple astropy
5353

54-
pip freeze
54+
python -m pip freeze
5555
!cov: pytest --pyargs astroquery {toxinidir}/docs {env:PYTEST_ARGS} {posargs}
5656
cov: pytest --pyargs astroquery {toxinidir}/docs --cov astroquery --cov-config={toxinidir}/setup.cfg {env:PYTEST_ARGS} {posargs}
5757
cov: coverage xml -o {toxinidir}/coverage.xml
@@ -74,7 +74,7 @@ extras = docs
7474
requires =
7575
sphinx
7676
commands =
77-
pip freeze
77+
python -m pip freeze
7878
python setup.py build_sphinx -W
7979

8080

@@ -83,5 +83,5 @@ changedir = {toxinidir}
8383
description = check the links in the HTML docs
8484
extras = docs
8585
commands =
86-
pip freeze
86+
python -m pip freeze
8787
python setup.py build_sphinx -W -b linkcheck

0 commit comments

Comments
 (0)