Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(README): update README #19

Merged
merged 1 commit into from
Mar 20, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 31 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,38 @@
# SGHI Commons

[![CI](https://github.com/savannahghi/sghi-commons/actions/workflows/ci.yml/badge.svg)](https://github.com/savannahghi/sghi-commons/actions/workflows/ci.yml)
[![pyversion](https://camo.githubusercontent.com/64bafa7ada773716674e93fd8fbaa3f681e1748865cdcb47cc373579079b767f/68747470733a2f2f696d672e736869656c64732e696f2f707970692f707976657273696f6e732f7365747570746f6f6c732e737667)](https://camo.githubusercontent.com/64bafa7ada773716674e93fd8fbaa3f681e1748865cdcb47cc373579079b767f/68747470733a2f2f696d672e736869656c64732e696f2f707970692f707976657273696f6e732f7365747570746f6f6c732e737667)
[![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)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
[![Coverage Status](https://coveralls.io/repos/github/savannahghi/sghi-commons/badge.svg?branch=develop)](https://coveralls.io/github/savannahghi/sghi-commons?branch=develop)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/savannahghi/sghi-commons/blob/main/LICENSE)
<h1 align="center" style="border-bottom: none; text-align: center;">SGHI Commons</h1>
<h3 align="center" style="text-align: center;">Collection of useful Python utilities.</h3>
<p align="center" style="text-align: center;">
<img alt="Python Version from PEP 621 TOML" src="https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fgithub.com%2Fsavannahghi%2Fsghi-commons%2Fraw%2Fdevelop%2Fpyproject.toml&logo=python&labelColor=white"/>
<a href="https://microsoft.github.io/pyright/">
<img alt="Checked with pyright" src="https://microsoft.github.io/pyright/img/pyright_badge.svg">
</a>
<a href="https://github.com/astral-sh/ruff">
<img alt="Ruff" src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json">
</a>
<a href="https://github.com/pre-commit/pre-commit">
<img alt="pre-commit" src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white">
</a>
<a href="https://github.com/semantic-release/semantic-release">
<img alt="Semantic Release: conventionalcommits" src="https://img.shields.io/badge/semantic--release-conventionalcommits-e10079?logo=semantic-release"/>
</a>
<a href="https://github.com/savannahghi/sghi-commons/blob/develop/LICENSE">
<img alt="GitHub License" src="https://img.shields.io/badge/License-MIT-blue.svg">
</a>
</p>
<p align="center" style="text-align: center;">
<a href="https://github.com/savannahghi/sghi-commons/actions/workflows/ci.yml">
<img alt="CI" src="https://github.com/savannahghi/sghi-commons/actions/workflows/ci.yml/badge.svg">
</a>
<a href="https://coveralls.io/github/savannahghi/sghi-commons?branch=develop">
<img alt="Coverage Status" src="https://img.shields.io/coverallsCoverage/github/savannahghi/sghi-commons?branch=develop&logo=coveralls&link=https%3A%2F%2Fcoveralls.io%2Fgithub%2Fsavannahghi%2Fsghi-commons%3Fbranch%3Ddevelop">
</a>
</p>

---

A collection of utilities and reusable components used throughout our Python
projects. They include:

- Utilities for working with resources that require freeing or cleanup after use.
- Components for defining and accessing application configurations.
- A registry component for storing key-value pairs.
- A signal dispatcher inspired by [PyDispatch](https://grass.osgeo.org/grass83/manuals/libpython/pydispatch.html) and [Django Dispatch](https://docs.djangoproject.com/en/dev/topics/signals/).
Expand Down