Skip to content

Commit

Permalink
DOC: use python -m pip
Browse files Browse the repository at this point in the history
  • Loading branch information
bsipocz committed Jul 25, 2023
1 parent 97efa55 commit c4894b9
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 18 deletions.
12 changes: 6 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,27 +55,27 @@ installed using `pip <https://pypi.python.org/pypi/pip>`_ or `anaconda
<http://continuum.io/>`_. Running the tests requires `curl
<https://curl.haxx.se/>`_ to be installed.

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

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

.. code-block:: bash
$ pip install --pre astroquery[all]
$ python -m pip install -U --pre astroquery[all]
To install the 'bleeding edge' version:

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

Expand All @@ -86,7 +86,7 @@ or cloned and installed from source:
$ # If you do not:
$ git clone https://github.com/astropy/astroquery.git
$ cd astroquery
$ pip install .
$ python -m pip install .
Using astroquery
----------------
Expand Down
12 changes: 6 additions & 6 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,19 +32,19 @@ releases are automatically uploaded to `PyPI <https://pypi.org/project/astroquer
and therefore the latest version of astroquery can be pip installed.
The version number of these automated releases contain the ``'dev'`` tag, thus pip needs to be told
to look for these releases during an upgrade, using the ``--pre`` install option. If astroquery is
already installed, please make sure you use the ``--upgrade`` install option as well.
already installed, please make sure you use the ``--upgrade`` (or ``-U``) install option as well.

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

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

.. code-block:: bash
$ pip install -e .[all,test,docs]
$ python -m pip install -e .[all,test,docs]
Requirements
Expand Down Expand Up @@ -123,7 +123,7 @@ full functionality of the `~astroquery.mocserver` module:
For the `~astroquery.vamdc` module:

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

The following packages are optional dependencies and are required for the
full functionality of the `~astroquery.mast` module:
Expand Down
2 changes: 1 addition & 1 deletion docs/vamdc/vamdc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Getting Started
The astroquery vamdc interface requires vamdclib_. The documentation is sparse
to nonexistent, but installation is straightforward::

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

This is the personal fork of the astroquery maintainer that includes astropy's
setup helpers on top of the vamdclib infrastructure. If the infrastructure is
Expand Down
10 changes: 5 additions & 5 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,10 @@ extras =


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

pip freeze
python -m pip freeze
!cov: pytest --pyargs astroquery {toxinidir}/docs {env:PYTEST_ARGS} {posargs}
cov: pytest --pyargs astroquery {toxinidir}/docs --cov astroquery --cov-config={toxinidir}/setup.cfg {env:PYTEST_ARGS} {posargs}
cov: coverage xml -o {toxinidir}/coverage.xml
Expand All @@ -74,7 +74,7 @@ extras = docs
requires =
sphinx
commands =
pip freeze
python -m pip freeze
python setup.py build_sphinx -W


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

0 comments on commit c4894b9

Please sign in to comment.