From 35a6e0fedd3a9c97462682961c39aa2ab03a87c7 Mon Sep 17 00:00:00 2001 From: Casper da Costa-Luis Date: Thu, 27 Feb 2020 23:32:10 +0000 Subject: [PATCH] docs: update badges (#3380) * docs: add and update badges Add |Choco| Add |Brew| Fix style for |Conda| Add |PyPI| Add |Packages| Fixes #3233 Related https://github.com/iterative/dvc.org/issues/904 * docs: add badge logos * docs: minor badge tidy * docs: add choco install, add OS, update order --- README.rst | 86 +++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 59 insertions(+), 27 deletions(-) diff --git a/README.rst b/README.rst index 9c24974bda..4c06602f4d 100644 --- a/README.rst +++ b/README.rst @@ -8,7 +8,9 @@ • `Tutorial `_ • `Mailing List `_ -|Release| |CI| |Maintainability| |Coverage| |Donate| |Conda| |Snap| |DOI| +|Release| |CI| |Maintainability| |Coverage| |Donate| |DOI| + +|Snap| |Choco| |Brew| |Conda| |PyPI| |Packages| | @@ -89,32 +91,36 @@ Installation There are four options to install DVC: ``pip``, Homebrew, Conda (Anaconda) or an OS-specific package. Full instructions are `available here `_. -pip (PyPI) ----------- +Snap (Snapcraft/Linux) +---------------------- + +|Snap| .. code-block:: bash - pip install dvc + snap install dvc --classic -Depending on the remote storage type you plan to use to keep and share your data, you might need to specify -one of the optional dependencies: ``s3``, ``gs``, ``azure``, ``oss``, ``ssh``. Or ``all`` to include them all. -The command should look like this: ``pip install dvc[s3]`` (in this case AWS S3 dependencies such as ``boto3`` -will be installed automatically). +This corresponds to the latest tagged release. +Add ``--edge`` for the latest ``master`` version. -To install the development version, run: +Choco (Chocolatey/Windows) +-------------------------- + +|Choco| .. code-block:: bash - pip install git+git://github.com/iterative/dvc + choco install dvc + +Brew (Homebrew/Mac OS) +---------------------- -Homebrew --------- +|Brew| .. code-block:: bash brew install dvc - Conda (Anaconda) ---------------- @@ -126,21 +132,31 @@ Conda (Anaconda) Currently, this includes support for Python versions 2.7, 3.6 and 3.7. -Snap (Snapcraft) ----------------- +pip (PyPI) +---------- -|Snap| +|PyPI| .. code-block:: bash - snap install dvc --classic + pip install dvc -This corresponds to the latest tagged release. -Add ``--edge`` for the latest ``master`` version. +Depending on the remote storage type you plan to use to keep and share your data, you might need to specify +one of the optional dependencies: ``s3``, ``gs``, ``azure``, ``oss``, ``ssh``. Or ``all`` to include them all. +The command should look like this: ``pip install dvc[s3]`` (in this case AWS S3 dependencies such as ``boto3`` +will be installed automatically). + +To install the development version, run: + +.. code-block:: bash + + pip install git+git://github.com/iterative/dvc Package ------- +|Packages| + Self-contained packages for Linux, Windows, and Mac are available. The latest version of the packages can be found on the GitHub `releases page `_. @@ -244,11 +260,11 @@ Iterative, *DVC: Data Version Control - Git for Data & Models* (2020) :alt: DVC logo .. |Release| image:: https://img.shields.io/badge/release-ok-brightgreen - :target: https://travis-ci.com/iterative/dvc + :target: https://travis-ci.com/iterative/dvc/branches :alt: Release -.. |CI| image:: https://img.shields.io/travis/com/iterative/dvc/master?label=dev - :target: https://travis-ci.com/iterative/dvc +.. |CI| image:: https://img.shields.io/travis/com/iterative/dvc/master?label=dev&logo=travis + :target: https://travis-ci.com/iterative/dvc/builds :alt: Travis dev branch .. |Maintainability| image:: https://codeclimate.com/github/iterative/dvc/badges/gpa.svg @@ -259,18 +275,34 @@ Iterative, *DVC: Data Version Control - Git for Data & Models* (2020) :target: https://codecov.io/gh/iterative/dvc :alt: Codecov -.. |Donate| image:: https://img.shields.io/badge/patreon-donate-green.svg +.. |Donate| image:: https://img.shields.io/badge/patreon-donate-green.svg?logo=patreon :target: https://www.patreon.com/DVCorg/overview :alt: Donate -.. |Conda| image:: https://anaconda.org/conda-forge/dvc/badges/version.svg - :target: https://anaconda.org/conda-forge/dvc - :alt: Conda-forge - .. |Snap| image:: https://img.shields.io/badge/snap-install-82BEA0.svg?logo=snapcraft :target: https://snapcraft.io/dvc :alt: Snapcraft +.. |Choco| image:: https://img.shields.io/chocolatey/v/dvc?label=choco + :target: https://chocolatey.org/packages/dvc + :alt: Chocolatey + +.. |Brew| image:: https://img.shields.io/homebrew/v/dvc?label=brew + :target: https://formulae.brew.sh/formula/dvc + :alt: Homebrew + +.. |Conda| image:: https://img.shields.io/conda/v/conda-forge/dvc.svg?label=conda&logo=conda-forge + :target: https://anaconda.org/conda-forge/dvc + :alt: Conda-forge + +.. |PyPI| image:: https://img.shields.io/pypi/v/dvc.svg?label=pip&logo=PyPI&logoColor=white + :target: https://pypi.org/project/dvc + :alt: PyPI + +.. |Packages| image:: https://img.shields.io/github/v/release/iterative/dvc?label=deb|pkg|rpm|exe&logo=GitHub + :target: https://github.com/iterative/dvc/releases/latest + :alt: deb|pkg|rpm|exe + .. |DOI| image:: https://img.shields.io/badge/DOI-10.5281/zenodo.3677553-blue.svg :target: https://doi.org/10.5281/zenodo.3677553 :alt: DOI