Skip to content

docs: Add conda-forge badge to README #500

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 25, 2024
Merged

docs: Add conda-forge badge to README #500

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c911553
docs: Add conda-forge badge to README
matthewfeickert Oct 25, 2024
79b5f10
docs: Add conda-forge install instructions to docs
matthewfeickert Oct 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
[![Code Coverage](https://codecov.io/gh/ssl-hep/ServiceX_frontend/graph/badge.svg)](https://codecov.io/gh/ssl-hep/ServiceX_frontend)

[![PyPI version](https://badge.fury.io/py/servicex.svg)](https://badge.fury.io/py/servicex)
[![conda-forge version](https://img.shields.io/conda/vn/conda-forge/servicex.svg)](https://github.com/conda-forge/servicex-feedstock.git)
[![Supported Python versions](https://img.shields.io/pypi/pyversions/servicex.svg)](https://pypi.org/project/servicex/)

[![Docs](https://readthedocs.org/projects/docs/badge/?version=latest)](https://servicex-frontend.readthedocs.io)
Expand Down
16 changes: 12 additions & 4 deletions docs/connect_servicex.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Setting to false preserves the full filename from the dataset.

ServiceX Client Installation
----------------------------
ServiceX client Python package is a python library for users to communicate
ServiceX client Python package is a python library for users to communicate
with ServiceX backend (or server) to make transformation requests and handling
of outputs.

Expand All @@ -101,8 +101,16 @@ Prerequisites
Installation
~~~~~~~~~~~~

The ServiceX client library can be installed either with ``pip``

.. code-block:: bash

python -m pip install servicex

or with ``conda``

.. code-block:: bash

pip install servicex

You're all set to make your ServiceX transformation request!
conda install --channel conda-forge servicex

You're all set to make your ServiceX transformation request!
14 changes: 11 additions & 3 deletions docs/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,17 @@ Installation
-------------


The ServiceX client library can be installed either with ``pip``

.. code-block:: bash

python -m pip install servicex

or with ``conda``

.. code-block:: bash
pip install servicex

conda install --channel conda-forge servicex

This installs the servicex command line tool and the servicex Python package.

Expand Down Expand Up @@ -63,4 +71,4 @@ downloaded to your computer.
You may place this in your home directory or within
the `servicex_frontend search path <https://github.com/ssl-hep/ServiceX_frontend#configuration>`_.

The remainder of this guide will use the xAOD instance.
The remainder of this guide will use the xAOD instance.
Loading