Skip to content

Commit

Permalink
Addition of badges for release (#608)
Browse files Browse the repository at this point in the history
* Badge fixes

* Badge zenodo addition

* Badge zenodo addition

* Addition of zenodo in docs

* Fixed doi issue

* Fixed doi issue

* Added main branch run and pointed badges to right main

* Edited branch name

---------

Co-authored-by: Tanmay Khandelwal <[email protected]>
  • Loading branch information
tanmayy24 and rythmm24 authored Dec 8, 2023
1 parent ff99c5d commit a72fc2c
Show file tree
Hide file tree
Showing 5 changed files with 35 additions and 10 deletions.
8 changes: 7 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
name: CI

on: pull_request
on:
push:
branches:
- master
pull_request:
branches:
- master

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
Expand Down
8 changes: 7 additions & 1 deletion .github/workflows/formatting.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
name: Formatting

on: pull_request
on:
push:
branches:
- master
pull_request:
branches:
- master

jobs:
black:
Expand Down
9 changes: 8 additions & 1 deletion .github/workflows/lint-python.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
name: Linting

on: pull_request
on:
push:
branches:
- master
pull_request:
branches:
- master

jobs:
lint_python:
name: "Lint and code analysis"
Expand Down
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,20 @@
# mirdata
Common loaders for Music Information Retrieval (MIR) datasets. Find the API documentation [here](https://mirdata.readthedocs.io/).

![CI status](https://github.com/mir-dataset-loaders/mirdata/actions/workflows/ci.yml/badge.svg)
![Formatting status](https://github.com/mir-dataset-loaders/mirdata/actions/workflows/formatting.yml/badge.svg)
![Linting status](https://github.com/mir-dataset-loaders/mirdata/actions/workflows/lint-python.yml/badge.svg)
[![codecov](https://codecov.io/gh/mir-dataset-loaders/mirdata/branch/master/graph/badge.svg)](https://codecov.io/gh/mir-dataset-loaders/mirdata)
![CI status](https://github.com/mir-dataset-loaders/mirdata/actions/workflows/ci.yml/badge.svg?branch=master)
![Formatting status](https://github.com/mir-dataset-loaders/mirdata/actions/workflows/formatting.yml/badge.svg?branch=master)
![Linting status](https://github.com/mir-dataset-loaders/mirdata/actions/workflows/lint-python.yml/badge.svg?branch=master)
[![Documentation Status](https://readthedocs.org/projects/mirdata/badge/?version=latest)](https://mirdata.readthedocs.io/en/latest/?badge=latest)
![GitHub](https://img.shields.io/github/license/mir-dataset-loaders/mirdata.svg)


[![PyPI version](https://badge.fury.io/py/mirdata.svg)](https://badge.fury.io/py/mirdata)
[![codecov](https://codecov.io/gh/mir-dataset-loaders/mirdata/branch/master/graph/badge.svg)](https://codecov.io/gh/mir-dataset-loaders/mirdata)
[![Downloads](https://static.pepy.tech/badge/mirdata)](https://pepy.tech/project/mirdata)
[![DOI](https://zenodo.org/badge/DOI/zenodo.10070589.svg)](https://doi.org/10.5281/zenodo.10070589)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)


This library provides tools for working with common MIR datasets, including tools for:
* downloading datasets to a common location and format
* validating that the files for a dataset are all present
Expand Down Expand Up @@ -53,7 +59,7 @@ There are two ways of citing mirdata:

If you are using the library for your work, please cite the version you used as indexed at Zenodo:

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4355859.svg)](https://doi.org/10.5281/zenodo.4355859)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10070589.svg)](https://doi.org/10.5281/zenodo.10070589)

If you refer to mirdata's design principles, motivation etc., please cite the following [paper](https://zenodo.org/record/3527750#.X-Inp5NKhUI):

Expand Down
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ Citing mirdata

If you are using the library for your work, please cite the version you used as indexed at Zenodo:

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4355859.svg
:target: https://doi.org/10.5281/zenodo.4355859
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.10070589.svg
:target: https://doi.org/10.5281/zenodo.10070589

If you refer to mirdata's design principles, motivation etc., please cite the following
`paper <https://magdalenafuentes.github.io/publications/2019_ISMIR_mirdata.pdf>`_ [#]_:
Expand Down

0 comments on commit a72fc2c

Please sign in to comment.