From aa46cd1405c98ca290939979e61cc59c1155f88f Mon Sep 17 00:00:00 2001 From: Casper da Costa-Luis Date: Fri, 21 Feb 2020 22:39:37 +0000 Subject: [PATCH 1/4] 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 --- README.rst | 34 +++++++++++++++++++++++++++++----- 1 file changed, 29 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 9c24974bda..b846f9ab0e 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| | @@ -92,6 +94,8 @@ Full instructions are `available here ` pip (PyPI) ---------- +|PyPI| + .. code-block:: bash pip install dvc @@ -110,6 +114,8 @@ To install the development version, run: Homebrew -------- +|Brew| + .. code-block:: bash brew install dvc @@ -141,6 +147,8 @@ Add ``--edge`` for the latest ``master`` version. 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 `_. @@ -263,14 +271,30 @@ Iterative, *DVC: Data Version Control - Git for Data & Models* (2020) :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 + :target: https://chocolatey.org/packages/dvc + :alt: Chocolatey + +.. |Brew| image:: https://img.shields.io/homebrew/v/dvc + :target: https://formulae.brew.sh/formula/dvc + :alt: Homebrew + +.. |Conda| image:: https://img.shields.io/conda/v/conda-forge/dvc.svg?label=conda-forge&logo=conda-forge + :target: https://anaconda.org/conda-forge/dvc + :alt: Conda-forge + +.. |PyPI| image:: https://img.shields.io/pypi/v/dvc.svg?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 From 6d567c9d366b141c2dc8e879b841f7de6b464cc4 Mon Sep 17 00:00:00 2001 From: Casper da Costa-Luis Date: Fri, 21 Feb 2020 22:44:13 +0000 Subject: [PATCH 2/4] docs: add badge logos --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index b846f9ab0e..12fed4b81f 100644 --- a/README.rst +++ b/README.rst @@ -255,7 +255,7 @@ Iterative, *DVC: Data Version Control - Git for Data & Models* (2020) :target: https://travis-ci.com/iterative/dvc :alt: Release -.. |CI| image:: https://img.shields.io/travis/com/iterative/dvc/master?label=dev +.. |CI| image:: https://img.shields.io/travis/com/iterative/dvc/master?label=dev&logo=travis :target: https://travis-ci.com/iterative/dvc :alt: Travis dev branch @@ -267,7 +267,7 @@ 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 From a02da49fe9c4367ec8bbc35611f0f3ece2f29449 Mon Sep 17 00:00:00 2001 From: Casper da Costa-Luis Date: Fri, 21 Feb 2020 22:49:24 +0000 Subject: [PATCH 3/4] docs: minor badge tidy --- README.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 12fed4b81f..1b2288508c 100644 --- a/README.rst +++ b/README.rst @@ -252,11 +252,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&logo=travis - :target: https://travis-ci.com/iterative/dvc + :target: https://travis-ci.com/iterative/dvc/builds :alt: Travis dev branch .. |Maintainability| image:: https://codeclimate.com/github/iterative/dvc/badges/gpa.svg @@ -275,19 +275,19 @@ Iterative, *DVC: Data Version Control - Git for Data & Models* (2020) :target: https://snapcraft.io/dvc :alt: Snapcraft -.. |Choco| image:: https://img.shields.io/chocolatey/v/dvc +.. |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 +.. |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-forge&logo=conda-forge +.. |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?logo=PyPI&logoColor=white +.. |PyPI| image:: https://img.shields.io/pypi/v/dvc.svg?label=pip&logo=PyPI&logoColor=white :target: https://pypi.org/project/dvc :alt: PyPI From e3d4c3f409b4a07d8f77e6339bd84823d41f7b6a Mon Sep 17 00:00:00 2001 From: Casper da Costa-Luis Date: Mon, 24 Feb 2020 15:17:28 +0000 Subject: [PATCH 4/4] docs: add choco install, add OS, update order --- README.rst | 46 +++++++++++++++++++++++++++------------------- 1 file changed, 27 insertions(+), 19 deletions(-) diff --git a/README.rst b/README.rst index 1b2288508c..4c06602f4d 100644 --- a/README.rst +++ b/README.rst @@ -91,28 +91,29 @@ 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) +---------------------- -|PyPI| +|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 -Homebrew --------- +Brew (Homebrew/Mac OS) +---------------------- |Brew| @@ -120,7 +121,6 @@ Homebrew brew install dvc - Conda (Anaconda) ---------------- @@ -132,17 +132,25 @@ 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 -------