diff --git a/.releaserc.yml b/.releaserc.yml index e9e03bc..171c7b8 100644 --- a/.releaserc.yml +++ b/.releaserc.yml @@ -27,6 +27,16 @@ plugins: hasChanged: true numMatches: 1 numReplacements: 1 + - countMatches: true + files: + - README.md + from: 'sghi-etl-commons.git@v.*' + to: 'sghi-etl-commons.git@v${nextRelease.version}' + results: + - file: README.md + hasChanged: true + numMatches: 1 + numReplacements: 1 - - '@semantic-release/changelog' - changelogFile: docs/CHANGELOG.md - - '@semantic-release/git' diff --git a/README.md b/README.md index a77bf76..02dcda9 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,23 @@

SGHI ETL Commons

Collection of utilities for working with SGHI ETL Workflows.

-

- Python Version from PEP 621 TOML - - Checked with pyright - - - Ruff - - - pre-commit - - - Semantic Release: conventionalcommits - - - GitHub License - -

-

- - CI - - - Coverage Status - -

+ +
+ +![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fsavannahghi%2Fsghi-etl-commons%2Fdevelop%2Fpyproject.toml&logo=python&labelColor=white) +[![Checked with pyright](https://microsoft.github.io/pyright/img/pyright_badge.svg)](https://microsoft.github.io/pyright/) +[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) +[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) +[![Semantic Release: conventionalcommits](https://img.shields.io/badge/semantic--release-conventionalcommits-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release) +[![GitHub License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/savannahghi/sghi-etl-commons/blob/develop/LICENSE) + +
+ +
+ +[![CI](https://github.com/savannahghi/sghi-etl-commons/actions/workflows/ci.yml/badge.svg)](https://github.com/savannahghi/sghi-etl-commons/actions/workflows/ci.yml) +[![Coverage Status](https://img.shields.io/coverallsCoverage/github/savannahghi/sghi-etl-commons?branch=develop&logo=coveralls)](https://coveralls.io/github/savannahghi/sghi-etl-commons?branch=develop) + +
--- @@ -34,6 +26,22 @@ projects. Specifically, this is a collection of common implementations of the interfaces defined by the [sghi-etl-core](https://github.com/savannahghi/sghi-etl-core/) project as well as other useful utilities. +## Getting Started + +`sghi-etl-commons` supports Python 3.11+. + +To install the latest stable release, use: + +```shell +pip install sghi-etl-commons@git+https://github.com/savannahghi/sghi-etl-commons.git@v1.1.0 +``` + +To install the latest development version, use: + +```shell +pip install sghi-etl-commons@git+https://github.com/savannahghi/sghi-etl-commons.git@develop +``` + ## Contribute Clone the project and run the following command to install dependencies: