Skip to content

Commit

Permalink
Merge pull request #14 from mbiokyle29/docs-badges-etc
Browse files Browse the repository at this point in the history
Docs badges etc
  • Loading branch information
mbiokyle29 authored Mar 27, 2024
2 parents 128074a + 69c8c9f commit 833c298
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .bumpversion.cfg
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[bumpversion]
current_version = 0.0.2
current_version = 0.0.3
commit = True
tag = False

Expand Down
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
# palamedes

![Merge - Passing](https://github.com/mammothbio-os/palamedes/actions/workflows/merge.yaml/badge.svg) ![Release - Passing](https://github.com/mammothbio-os/palamedes/actions/workflows/release.yaml/badge.svg) ![PyPI - Version](https://img.shields.io/pypi/v/palamedes) ![Read The Docs - Version](https://readthedocs.org/projects/mammothbio-os-palamedes/badge/?version=stable)

This repo contains a python package and CLI entrypoint which can be used to generate a list of [HGVS](https://github.com/biocommons/hgvs) variants representing the difference between 2 sequences, using a global alignment. The idea is to leverage the HGVS spec for more applications, since it provides a solid framework for maintaining a consistent set of rules and logic
around variants.

## Documentation

Documentation for the project can be found [here](https://mammothbio-os-palamedes.readthedocs.io/en/stable/)

## Installing

Palamedes is packaged in PyPI, to install simply run: `pip install palamedes`
Expand Down
2 changes: 1 addition & 1 deletion palamedes/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
from palamedes.hgvs.builders import BUILDER_CONFIG


__version__ = "0.0.2"
__version__ = "0.0.3"


def generate_hgvs_variants(
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
from setuptools import find_packages, setup

version = "0.0.2"
version = "0.0.3"

setup(
name="palamedes",
Expand Down

0 comments on commit 833c298

Please sign in to comment.