Metadata-Version: 2.1
Name: sam-alignment-reconstructor
Version: 0.0.3
Summary: SAM Alignment Reconstructor
Home-page: https://github.com/lairdm/sam-alignment-reconstructor.git
Author: Matthew Laird
Author-email: lairdm@ebi.ac.uk
License: Apache 2.0
Keywords: sam alignment bioinformatics
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, <4
Provides-Extra: lint
Provides-Extra: docs
Provides-Extra: dev
Provides-Extra: test
Requires-Dist: click (==6.7)
Requires-Dist: simplesam (==0.1.2)
Requires-Dist: six (==1.11.0)
Requires-Dist: future (>=0.16.0)
Provides-Extra: dev
Requires-Dist: tox; extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx (>=1.7.5); extra == 'docs'
Requires-Dist: sphinxcontrib-fulltoc; extra == 'docs'
Requires-Dist: tox; extra == 'docs'
Provides-Extra: lint
Requires-Dist: pylint; extra == 'lint'
Requires-Dist: tox; extra == 'lint'
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Requires-Dist: tox; extra == 'test'

Overview
########

This package is design to reconstruct pairwise alignments from SAM files using the CIGAR string and MD:Z tag

It can be used as a standalone command line tool, or as a library when get the three elements above.

Usage
#####

To install the package, enable the virtual environment where it's going to be used and run

::

  $ pip install sam-alignment-reconstructor
  $ cat file.sam | sam-alignment-reconstructor

Developing
##########

To prepare the environment for developing the library, create a virtual environment, go to project root and then run:

::

  $ pip install -e .[dev]

Testing
#######
The recommended way is to test using detox.
This allows for testing in all the supported python versions using virtual environments effortlessly.
To use, install it, then run in the project root:

::

  $ pip install detox
  $ detox

Alternatively, testing can be done in the same environment as the dev one by installing it's dependencies, then running pytest:

::

  $ pip install -e .[test]
  $ python -m pytest -s


