Skip to content

Commit

Permalink
[ENH] Add consistent badges (#387)
Browse files Browse the repository at this point in the history
* [ENH] Add consistent badges
  • Loading branch information
surchs authored Dec 12, 2024
1 parent c9a77b2 commit f8e9fe2
Showing 1 changed file with 24 additions and 22 deletions.
46 changes: 24 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,38 @@
<div align="center">

# Neurobagel API

[![Tests](https://img.shields.io/github/actions/workflow/status/neurobagel/api/test.yaml?color=BDB76B&label=test&style=flat)](https://github.com/neurobagel/api/actions/workflows/test.yaml)
[![codecov](https://codecov.io/gh/neurobagel/api/graph/badge.svg?token=ZEOGQFFZMJ)](https://codecov.io/gh/neurobagel/api)
[![Python](https://img.shields.io/badge/python-3.10-4682B4?style=flat)](https://www.python.org/)
[![License](https://img.shields.io/github/license/neurobagel/api?color=CD5C5C&style=flat)](LICENSE)
![Docker Image Version (tag)](https://img.shields.io/docker/v/neurobagel/api/latest?logo=docker)

![GitHub branch check runs](https://img.shields.io/github/check-runs/neurobagel/api/main?style=flat-square)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/neurobagel/api/test.yaml?branch=main&style=flat-square&label=tests)
![Codecov](https://img.shields.io/codecov/c/github/neurobagel/api?token=ZEOGQFFZMJ&style=flat-square&logo=codecov&link=https%3A%2F%2Fcodecov.io%2Fgh%2Fneurobagel%2Fapi)
![Static Badge](https://img.shields.io/badge/python-3.10-blue?style=flat-square&logo=python)
![GitHub License](https://img.shields.io/github/license/neurobagel/api?style=flat-square&color=purple&link=LICENSE)
![Docker Image Version (tag)](https://img.shields.io/docker/v/neurobagel/api/latest?style=flat-square&logo=docker&link=https%3A%2F%2Fhub.docker.com%2Fr%2Fneurobagel%2Fapi%2Ftags)
![Docker Pulls](https://img.shields.io/docker/pulls/neurobagel/api?style=flat-square&logo=docker&link=https%3A%2F%2Fhub.docker.com%2Fr%2Fneurobagel%2Fapi%2Ftags)

</div>

The Neurobagel API is a REST API, developed in [Python](https://www.python.org/) using [FastAPI](https://fastapi.tiangolo.com/) and [Pydantic](https://docs.pydantic.dev/).

Please refer to our [**official documentation**](https://neurobagel.org/user_guide/api/) for more information on how to use the API.

- [Quickstart](#quickstart)
- [Local installation](#local-installation)
- [Clone the repo](#clone-the-repo)
- [Set the environment variables](#set-the-environment-variables)
- [Docker](#docker)
- [Option 1 (RECOMMENDED): Use the Neurobagel Docker Compose recipe](#option-1-recommended-use-the-neurobagel-docker-compose-recipe)
- [Option 2: Use the latest image from Docker Hub](#option-2-use-the-latest-image-from-docker-hub)
- [Option 3: Build the image using the Dockerfile](#option-3-build-the-image-using-the-dockerfile)
- [Send a test query to the API](#send-a-test-query-to-the-api)
- [Python](#python)
- [Install dependencies](#install-dependencies)
- [Launch the API](#launch-the-api)
- [Troubleshooting](#troubleshooting)
- [Testing](#testing)
- [The default Neurobagel SPARQL query](#the-default-neurobagel-sparql-query)
- [License](#license)
- [Neurobagel API](#neurobagel-api)
- [Quickstart](#quickstart)
- [Local installation](#local-installation)
- [Clone the repo](#clone-the-repo)
- [Set the environment variables](#set-the-environment-variables)
- [Docker](#docker)
- [Option 1 (RECOMMENDED): Use the Neurobagel Docker Compose recipe](#option-1-recommended-use-the-neurobagel-docker-compose-recipe)
- [Option 2: Use the latest image from Docker Hub](#option-2-use-the-latest-image-from-docker-hub)
- [Option 3: Build the image using the Dockerfile](#option-3-build-the-image-using-the-dockerfile)
- [Send a test query to the API](#send-a-test-query-to-the-api)
- [Python](#python)
- [Install dependencies](#install-dependencies)
- [Launch the API](#launch-the-api)
- [Troubleshooting](#troubleshooting)
- [Testing](#testing)
- [The default Neurobagel SPARQL query](#the-default-neurobagel-sparql-query)
- [License](#license)


## Quickstart
Expand Down

0 comments on commit f8e9fe2

Please sign in to comment.