Skip to content

Commit ae99e1b

Browse files
authored
metadata: add Zenodo, tidy badges and keywords (iterative#3373)
* docs: add Zenodo badge * docs: fix rst image syntax * docs: collect and re-use badges * metadata: add zenodo Fixes iterative#2978 * metadata: sync keywords * docs: add citation in readme * docs: one-line badges
1 parent 2c46bdd commit ae99e1b

File tree

3 files changed

+84
-50
lines changed

3 files changed

+84
-50
lines changed

.zenodo.json

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"title": "DVC: Data Version Control - Git for Data & Models",
3+
"keywords": [
4+
"data-science", "data-version-control", "machine-learning", "git",
5+
"developer-tools", "reproducibility", "collaboration", "ai", "python"],
6+
"contributors": [
7+
{"name": "DVC team", "type": "Other", "affiliation": "Iterative"}]
8+
}

README.rst

+74-49
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
.. image:: https://dvc.org/static/img/logo-github-readme.png
2-
:target: https://dvc.org
3-
:alt: DVC logo
1+
|Banner|
42

53
`Website <https://dvc.org>`_
64
• `Docs <https://dvc.org/doc>`_
@@ -10,33 +8,7 @@
108
• `Tutorial <https://dvc.org/doc/get-started>`_
119
• `Mailing List <https://sweedom.us10.list-manage.com/subscribe/post?u=a08bf93caae4063c4e6a351f6&id=24c0ecc49a>`_
1210

13-
.. image:: https://img.shields.io/badge/release-ok-brightgreen
14-
:target: https://travis-ci.com/iterative/dvc
15-
:alt: Release
16-
17-
.. image:: https://img.shields.io/travis/com/iterative/dvc/master?label=dev
18-
:target: https://travis-ci.com/iterative/dvc
19-
:alt: Travis dev branch
20-
21-
.. image:: https://codeclimate.com/github/iterative/dvc/badges/gpa.svg
22-
:target: https://codeclimate.com/github/iterative/dvc
23-
:alt: Code Climate
24-
25-
.. image:: https://codecov.io/gh/iterative/dvc/branch/master/graph/badge.svg
26-
:target: https://codecov.io/gh/iterative/dvc
27-
:alt: Codecov
28-
29-
.. image:: https://img.shields.io/badge/patreon-donate-green.svg
30-
:target: https://www.patreon.com/DVCorg/overview
31-
:alt: Donate
32-
33-
.. image:: https://anaconda.org/conda-forge/dvc/badges/version.svg
34-
:target: https://anaconda.org/conda-forge/dvc
35-
:alt: Conda-forge
36-
37-
.. image:: https://img.shields.io/badge/snap-install-82BEA0.svg?logo=snapcraft
38-
:target: https://snapcraft.io/dvc
39-
:alt: Snapcraft
11+
|Release| |CI| |Maintainability| |Coverage| |Donate| |Conda| |Snap| |DOI|
4012

4113
|
4214
@@ -79,9 +51,7 @@ to store data and model files seamlessly out of Git, while preserving almost the
7951
were stored in Git itself. To store and share the data cache, DVC supports multiple remotes - any cloud (S3, Azure,
8052
Google Cloud, etc) or any on-premise network storage (via SSH, for example).
8153

82-
.. image:: https://dvc.org/static/img/flow.gif
83-
:target: https://dvc.org/static/img/flow.gif
84-
:alt: how_dvc_works
54+
|Flowchart|
8555

8656
The DVC pipelines (computational graph) feature connects code and data together. It is possible to explicitly
8757
specify all steps required to produce a model: input dependencies including data, commands to run,
@@ -148,6 +118,8 @@ Homebrew
148118
Conda (Anaconda)
149119
----------------
150120

121+
|Conda|
122+
151123
.. code-block:: bash
152124
153125
conda install -c conda-forge dvc
@@ -157,6 +129,8 @@ Currently, this includes support for Python versions 2.7, 3.6 and 3.7.
157129
Snap (Snapcraft)
158130
----------------
159131

132+
|Snap|
133+
160134
.. code-block:: bash
161135
162136
snap install dvc --classic
@@ -206,40 +180,43 @@ Comparison to related technologies
206180

207181
Contributing
208182
============
183+
184+
|Maintainability| |Donate|
185+
209186
Contributions are welcome! Please see our `Contributing Guide <https://dvc.org/doc/user-guide/contributing/core>`_ for more
210187
details.
211188

212189
.. image:: https://sourcerer.io/fame/efiop/iterative/dvc/images/0
213-
:target: https://sourcerer.io/fame/efiop/iterative/dvc/links/0
214-
:alt: 0
190+
:target: https://sourcerer.io/fame/efiop/iterative/dvc/links/0
191+
:alt: 0
215192

216193
.. image:: https://sourcerer.io/fame/efiop/iterative/dvc/images/1
217-
:target: https://sourcerer.io/fame/efiop/iterative/dvc/links/1
218-
:alt: 1
194+
:target: https://sourcerer.io/fame/efiop/iterative/dvc/links/1
195+
:alt: 1
219196

220197
.. image:: https://sourcerer.io/fame/efiop/iterative/dvc/images/2
221-
:target: https://sourcerer.io/fame/efiop/iterative/dvc/links/2
222-
:alt: 2
198+
:target: https://sourcerer.io/fame/efiop/iterative/dvc/links/2
199+
:alt: 2
223200

224201
.. image:: https://sourcerer.io/fame/efiop/iterative/dvc/images/3
225-
:target: https://sourcerer.io/fame/efiop/iterative/dvc/links/3
226-
:alt: 3
202+
:target: https://sourcerer.io/fame/efiop/iterative/dvc/links/3
203+
:alt: 3
227204

228205
.. image:: https://sourcerer.io/fame/efiop/iterative/dvc/images/4
229-
:target: https://sourcerer.io/fame/efiop/iterative/dvc/links/4
230-
:alt: 4
206+
:target: https://sourcerer.io/fame/efiop/iterative/dvc/links/4
207+
:alt: 4
231208

232209
.. image:: https://sourcerer.io/fame/efiop/iterative/dvc/images/5
233-
:target: https://sourcerer.io/fame/efiop/iterative/dvc/links/5
234-
:alt: 5
210+
:target: https://sourcerer.io/fame/efiop/iterative/dvc/links/5
211+
:alt: 5
235212

236213
.. image:: https://sourcerer.io/fame/efiop/iterative/dvc/images/6
237-
:target: https://sourcerer.io/fame/efiop/iterative/dvc/links/6
238-
:alt: 6
214+
:target: https://sourcerer.io/fame/efiop/iterative/dvc/links/6
215+
:alt: 6
239216

240217
.. image:: https://sourcerer.io/fame/efiop/iterative/dvc/images/7
241-
:target: https://sourcerer.io/fame/efiop/iterative/dvc/links/7
242-
:alt: 7
218+
:target: https://sourcerer.io/fame/efiop/iterative/dvc/links/7
219+
:alt: 7
243220

244221
Mailing List
245222
============
@@ -253,3 +230,51 @@ This project is distributed under the Apache license version 2.0 (see the LICENS
253230

254231
By submitting a pull request to this project, you agree to license your contribution under the Apache license version
255232
2.0 to this project.
233+
234+
Citation
235+
========
236+
237+
|DOI|
238+
239+
Iterative, *DVC: Data Version Control - Git for Data & Models* (2020)
240+
`DOI:10.5281/zenodo.012345 <https://doi.org/10.5281/zenodo.3677553>`_.
241+
242+
.. |Banner| image:: https://dvc.org/static/img/logo-github-readme.png
243+
:target: https://dvc.org
244+
:alt: DVC logo
245+
246+
.. |Release| image:: https://img.shields.io/badge/release-ok-brightgreen
247+
:target: https://travis-ci.com/iterative/dvc
248+
:alt: Release
249+
250+
.. |CI| image:: https://img.shields.io/travis/com/iterative/dvc/master?label=dev
251+
:target: https://travis-ci.com/iterative/dvc
252+
:alt: Travis dev branch
253+
254+
.. |Maintainability| image:: https://codeclimate.com/github/iterative/dvc/badges/gpa.svg
255+
:target: https://codeclimate.com/github/iterative/dvc
256+
:alt: Code Climate
257+
258+
.. |Coverage| image:: https://codecov.io/gh/iterative/dvc/branch/master/graph/badge.svg
259+
:target: https://codecov.io/gh/iterative/dvc
260+
:alt: Codecov
261+
262+
.. |Donate| image:: https://img.shields.io/badge/patreon-donate-green.svg
263+
:target: https://www.patreon.com/DVCorg/overview
264+
:alt: Donate
265+
266+
.. |Conda| image:: https://anaconda.org/conda-forge/dvc/badges/version.svg
267+
:target: https://anaconda.org/conda-forge/dvc
268+
:alt: Conda-forge
269+
270+
.. |Snap| image:: https://img.shields.io/badge/snap-install-82BEA0.svg?logo=snapcraft
271+
:target: https://snapcraft.io/dvc
272+
:alt: Snapcraft
273+
274+
.. |DOI| image:: https://img.shields.io/badge/DOI-10.5281/zenodo.3677553-blue.svg
275+
:target: https://doi.org/10.5281/zenodo.3677553
276+
:alt: DOI
277+
278+
.. |Flowchart| image:: https://dvc.org/static/img/flow.gif
279+
:target: https://dvc.org/static/img/flow.gif
280+
:alt: how_dvc_works

setup.py

+2-1
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,8 @@ def run(self):
148148
"hdfs": hdfs,
149149
"tests": tests_requirements,
150150
},
151-
keywords="data science, data version control, machine learning",
151+
keywords="data-science data-version-control machine-learning git"
152+
" developer-tools reproducibility collaboration ai",
152153
python_requires=">=3.5",
153154
classifiers=[
154155
"Development Status :: 4 - Beta",

0 commit comments

Comments
 (0)