Skip to content
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.

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

Added documentation of pyDataverse conda installation (again) #184

Merged
merged 1 commit into from
May 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -863,7 +863,7 @@ related to release activities), the release can be created. This includes:
- update version number
- merge ``develop`` to ``master``
- tag release name to commit (e. g. ``v0.3.0``), push branch and create pull request
- upload to `PyPI <https://pypi.org/>`_
- upload to `PyPI <https://pypi.org/>`_ and `conda-forge <https://conda-fore.org/>`_

You can find the full release history at :ref:`community_history` and on
`GitHub <https://github.com/gdcc/pyDataverse/releases>`_.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[![PyPI](https://img.shields.io/pypi/v/pyDataverse.svg)](https://pypi.org/project/pyDataverse/) ![Build Status](https://github.com/gdcc/pyDataverse/actions/workflows/test_build.yml/badge.svg) [![Coverage Status](https://coveralls.io/repos/github/gdcc/pyDataverse/badge.svg)](https://coveralls.io/github/gdcc/pyDataverse) [![Documentation Status](https://readthedocs.org/projects/pydataverse/badge/?version=latest)](https://pydataverse.readthedocs.io/en/latest) <img src="https://img.shields.io/badge/python-3.8 | 3.9 | 3.10 | 3.11-blue.svg" alt="PyPI - Python Version"> [![GitHub](https://img.shields.io/github/license/gdcc/pydataverse.svg)](https://opensource.org/licenses/MIT) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4664557.svg)](https://doi.org/10.5281/zenodo.4664557)
[![PyPI](https://img.shields.io/pypi/v/pyDataverse.svg)](https://pypi.org/project/pyDataverse/) [![Conda Version](https://img.shields.io/conda/vn/conda-forge/pydataverse.svg)](https://anaconda.org/conda-forge/pydataverse/) ![Build Status](https://github.com/gdcc/pyDataverse/actions/workflows/test_build.yml/badge.svg) [![Coverage Status](https://coveralls.io/repos/github/gdcc/pyDataverse/badge.svg)](https://coveralls.io/github/gdcc/pyDataverse) [![Documentation Status](https://readthedocs.org/projects/pydataverse/badge/?version=latest)](https://pydataverse.readthedocs.io/en/latest) <img src="https://img.shields.io/badge/python-3.8 | 3.9 | 3.10 | 3.11-blue.svg" alt="PyPI - Python Version"> [![GitHub](https://img.shields.io/github/license/gdcc/pydataverse.svg)](https://opensource.org/licenses/MIT) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4664557.svg)](https://doi.org/10.5281/zenodo.4664557)

# pyDataverse

Expand Down
8 changes: 8 additions & 0 deletions pyDataverse/docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ Release v\ |version|.
.. image:: https://img.shields.io/github/v/release/gdcc/pyDataverse
:target: https://github.com/gdcc/pyDataverse

.. image:: https://img.shields.io/conda/vn/conda-forge/pydataverse.svg
:target: https://anaconda.org/conda-forge/pydataverse

.. image:: https://travis-ci.com/gdcc/pyDataverse.svg?branch=master
:target: https://travis-ci.com/gdcc/pyDataverse

Expand Down Expand Up @@ -68,6 +71,11 @@ To install pyDataverse, simply run this command in your terminal of choice:
pip install pyDataverse
Or run this command to install using conda:

.. code-block:: shell
conda install pyDataverse -c conda-forge
Find more options at :ref:`user_installation`.

Expand Down
11 changes: 11 additions & 0 deletions pyDataverse/docs/source/user/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,17 @@ Pipenv
.. _user_installation_source-code:


Conda
-----------------------------

pyDataverse is also available through `conda-forge <https://conda-forge.org/>`_.

.. code-block:: shell
conda install pyDataverse -c conda-forge
Source Code
-----------------------------

Expand Down