Skip to content

Commit

Permalink
doc: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
msto committed Apr 11, 2024
1 parent c96e603 commit d8d1a23
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,21 @@
# sam_tags
# `sam_tags`

[![CI](https://github.com/msto/sam_tags/actions/workflows/python_package.yml/badge.svg?branch=main)](https://github.com/msto/sam_tags/actions/workflows/python_package.yml?query=branch%3Amain)
[![Python Versions](https://img.shields.io/badge/python-3.11_|_3.12-blue)](https://github.com/msto/sam_tags)
[![MyPy Checked](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://docs.astral.sh/ruff/)

SAM tags
[SAM tags](https://samtools.github.io/hts-specs/SAMtags.pdf) in Python.

This package provides
1. A class decorator (`sam_tag`) to validate that locally-defined SAM tags adhere to the SAM spec.
2. Built-in enumerations over the predefined standard tags (`StandardTag`) and the tags used by several popular bioinformatics programs.

## Installation

```console
$ pip install sam_tags
```

## Quickstart

Expand Down

0 comments on commit d8d1a23

Please sign in to comment.