From eb580210bded2d6242ddd9012d559336a1745c37 Mon Sep 17 00:00:00 2001 From: Casper da Costa-Luis Date: Thu, 20 Feb 2020 22:26:26 +0000 Subject: [PATCH 1/7] docs: add Zenodo badge --- README.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.rst b/README.rst index 12f974cd99..ff0e638e75 100644 --- a/README.rst +++ b/README.rst @@ -14,6 +14,10 @@ :target: https://travis-ci.com/iterative/dvc :alt: Release +.. image:: https://img.shields.io/badge/DOI-10.5281/zenodo.3677553-blue.svg + :target: https://doi.org/10.5281/zenodo.3677553 + :alt: DOI + .. image:: https://img.shields.io/travis/com/iterative/dvc/master?label=dev :target: https://travis-ci.com/iterative/dvc :alt: Travis dev branch From 4bf1d5cd7df29dfb7dd6922a0fca887b05714965 Mon Sep 17 00:00:00 2001 From: Casper da Costa-Luis Date: Thu, 20 Feb 2020 22:26:48 +0000 Subject: [PATCH 2/7] docs: fix rst image syntax --- README.rst | 68 +++++++++++++++++++++++++++--------------------------- 1 file changed, 34 insertions(+), 34 deletions(-) diff --git a/README.rst b/README.rst index ff0e638e75..dfa9a732c6 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,6 @@ .. image:: https://dvc.org/static/img/logo-github-readme.png - :target: https://dvc.org - :alt: DVC logo + :target: https://dvc.org + :alt: DVC logo `Website `_ • `Docs `_ @@ -11,36 +11,36 @@ • `Mailing List `_ .. image:: https://img.shields.io/badge/release-ok-brightgreen - :target: https://travis-ci.com/iterative/dvc - :alt: Release + :target: https://travis-ci.com/iterative/dvc + :alt: Release .. image:: https://img.shields.io/badge/DOI-10.5281/zenodo.3677553-blue.svg - :target: https://doi.org/10.5281/zenodo.3677553 - :alt: DOI + :target: https://doi.org/10.5281/zenodo.3677553 + :alt: DOI .. image:: https://img.shields.io/travis/com/iterative/dvc/master?label=dev - :target: https://travis-ci.com/iterative/dvc - :alt: Travis dev branch + :target: https://travis-ci.com/iterative/dvc + :alt: Travis dev branch .. image:: https://codeclimate.com/github/iterative/dvc/badges/gpa.svg - :target: https://codeclimate.com/github/iterative/dvc - :alt: Code Climate + :target: https://codeclimate.com/github/iterative/dvc + :alt: Code Climate .. image:: https://codecov.io/gh/iterative/dvc/branch/master/graph/badge.svg - :target: https://codecov.io/gh/iterative/dvc - :alt: Codecov + :target: https://codecov.io/gh/iterative/dvc + :alt: Codecov .. image:: https://img.shields.io/badge/patreon-donate-green.svg - :target: https://www.patreon.com/DVCorg/overview - :alt: Donate + :target: https://www.patreon.com/DVCorg/overview + :alt: Donate .. image:: https://anaconda.org/conda-forge/dvc/badges/version.svg - :target: https://anaconda.org/conda-forge/dvc - :alt: Conda-forge + :target: https://anaconda.org/conda-forge/dvc + :alt: Conda-forge .. image:: https://img.shields.io/badge/snap-install-82BEA0.svg?logo=snapcraft - :target: https://snapcraft.io/dvc - :alt: Snapcraft + :target: https://snapcraft.io/dvc + :alt: Snapcraft | @@ -214,36 +214,36 @@ Contributions are welcome! Please see our `Contributing Guide Date: Thu, 20 Feb 2020 22:37:51 +0000 Subject: [PATCH 3/7] docs: collect and re-use badges --- README.rst | 92 ++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 62 insertions(+), 30 deletions(-) diff --git a/README.rst b/README.rst index dfa9a732c6..aed257bbed 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,4 @@ -.. image:: https://dvc.org/static/img/logo-github-readme.png - :target: https://dvc.org - :alt: DVC logo +|Banner| `Website `_ • `Docs `_ @@ -10,37 +8,21 @@ • `Tutorial `_ • `Mailing List `_ -.. image:: https://img.shields.io/badge/release-ok-brightgreen - :target: https://travis-ci.com/iterative/dvc - :alt: Release +|Release| -.. image:: https://img.shields.io/badge/DOI-10.5281/zenodo.3677553-blue.svg - :target: https://doi.org/10.5281/zenodo.3677553 - :alt: DOI +|CI| -.. image:: https://img.shields.io/travis/com/iterative/dvc/master?label=dev - :target: https://travis-ci.com/iterative/dvc - :alt: Travis dev branch +|Maintainability| -.. image:: https://codeclimate.com/github/iterative/dvc/badges/gpa.svg - :target: https://codeclimate.com/github/iterative/dvc - :alt: Code Climate +|Coverage| -.. image:: https://codecov.io/gh/iterative/dvc/branch/master/graph/badge.svg - :target: https://codecov.io/gh/iterative/dvc - :alt: Codecov +|Donate| -.. image:: https://img.shields.io/badge/patreon-donate-green.svg - :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 +|DOI| | @@ -83,9 +65,7 @@ to store data and model files seamlessly out of Git, while preserving almost the were stored in Git itself. To store and share the data cache, DVC supports multiple remotes - any cloud (S3, Azure, Google Cloud, etc) or any on-premise network storage (via SSH, for example). -.. image:: https://dvc.org/static/img/flow.gif - :target: https://dvc.org/static/img/flow.gif - :alt: how_dvc_works +|Flowchart| The DVC pipelines (computational graph) feature connects code and data together. It is possible to explicitly specify all steps required to produce a model: input dependencies including data, commands to run, @@ -152,6 +132,8 @@ Homebrew Conda (Anaconda) ---------------- +|Conda| + .. code-block:: bash conda install -c conda-forge dvc @@ -161,6 +143,8 @@ Currently, this includes support for Python versions 2.7, 3.6 and 3.7. Snap (Snapcraft) ---------------- +|Snap| + .. code-block:: bash snap install dvc --classic @@ -210,6 +194,9 @@ Comparison to related technologies Contributing ============ + +|Maintainability| |Donate| + Contributions are welcome! Please see our `Contributing Guide `_ for more details. @@ -257,3 +244,48 @@ This project is distributed under the Apache license version 2.0 (see the LICENS By submitting a pull request to this project, you agree to license your contribution under the Apache license version 2.0 to this project. + +Citation +======== + +|DOI| + +.. |Banner| image:: https://dvc.org/static/img/logo-github-readme.png + :target: https://dvc.org + :alt: DVC logo + +.. |Release| image:: https://img.shields.io/badge/release-ok-brightgreen + :target: https://travis-ci.com/iterative/dvc + :alt: Release + +.. |CI| image:: https://img.shields.io/travis/com/iterative/dvc/master?label=dev + :target: https://travis-ci.com/iterative/dvc + :alt: Travis dev branch + +.. |Maintainability| image:: https://codeclimate.com/github/iterative/dvc/badges/gpa.svg + :target: https://codeclimate.com/github/iterative/dvc + :alt: Code Climate + +.. |Coverage| image:: https://codecov.io/gh/iterative/dvc/branch/master/graph/badge.svg + :target: https://codecov.io/gh/iterative/dvc + :alt: Codecov + +.. |Donate| image:: https://img.shields.io/badge/patreon-donate-green.svg + :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 + +.. |DOI| image:: https://img.shields.io/badge/DOI-10.5281/zenodo.3677553-blue.svg + :target: https://doi.org/10.5281/zenodo.3677553 + :alt: DOI + +.. |Flowchart| image:: https://dvc.org/static/img/flow.gif + :target: https://dvc.org/static/img/flow.gif + :alt: how_dvc_works From c3eee90c649c7e3ca503e639e9540c62795ae10f Mon Sep 17 00:00:00 2001 From: Casper da Costa-Luis Date: Thu, 20 Feb 2020 22:47:24 +0000 Subject: [PATCH 4/7] metadata: add zenodo Fixes #2978 --- .zenodo.json | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 .zenodo.json diff --git a/.zenodo.json b/.zenodo.json new file mode 100644 index 0000000000..4e110ab044 --- /dev/null +++ b/.zenodo.json @@ -0,0 +1,8 @@ +{ + "title": "DVC: Data Version Control - Git for Data & Models", + "keywords": [ + "data-science", "data-version-control", "machine-learning", "git", + "developer-tools", "reproducibility", "collaboration", "ai", "python"], + "contributors": [ + {"name": "DVC team", "type": "Other", "affiliation": "Iterative"}] +} From 676f9813bd308740ed6cfb86fe67689393454040 Mon Sep 17 00:00:00 2001 From: Casper da Costa-Luis Date: Thu, 20 Feb 2020 22:47:37 +0000 Subject: [PATCH 5/7] metadata: sync keywords --- setup.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/setup.py b/setup.py index b39a1f6e91..88b111960e 100644 --- a/setup.py +++ b/setup.py @@ -148,7 +148,8 @@ def run(self): "hdfs": hdfs, "tests": tests_requirements, }, - keywords="data science, data version control, machine learning", + keywords="data-science data-version-control machine-learning git" + " developer-tools reproducibility collaboration ai", python_requires=">=3.5", classifiers=[ "Development Status :: 4 - Beta", From f5fed3492d9229ff705068287a19cc6adfa6a238 Mon Sep 17 00:00:00 2001 From: Casper da Costa-Luis Date: Thu, 20 Feb 2020 23:05:38 +0000 Subject: [PATCH 6/7] docs: add citation in readme --- README.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.rst b/README.rst index aed257bbed..de05d7bcdc 100644 --- a/README.rst +++ b/README.rst @@ -250,6 +250,9 @@ Citation |DOI| +Iterative, *DVC: Data Version Control - Git for Data & Models* (2020) +`DOI:10.5281/zenodo.012345 `_. + .. |Banner| image:: https://dvc.org/static/img/logo-github-readme.png :target: https://dvc.org :alt: DVC logo From 275c5d5f2c390b2bfaa12cf6cc5e0881eb6b591b Mon Sep 17 00:00:00 2001 From: Casper da Costa-Luis Date: Fri, 21 Feb 2020 00:00:37 +0000 Subject: [PATCH 7/7] docs: one-line badges --- README.rst | 16 +--------------- 1 file changed, 1 insertion(+), 15 deletions(-) diff --git a/README.rst b/README.rst index de05d7bcdc..9c24974bda 100644 --- a/README.rst +++ b/README.rst @@ -8,21 +8,7 @@ • `Tutorial `_ • `Mailing List `_ -|Release| - -|CI| - -|Maintainability| - -|Coverage| - -|Donate| - -|Conda| - -|Snap| - -|DOI| +|Release| |CI| |Maintainability| |Coverage| |Donate| |Conda| |Snap| |DOI| |