Metadata-Version: 2.1
Name: watersnake
Version: 0.1.0
Summary: Minimal WFA2-lib wrapper in Python
Author-email: Travis Wrightsman <tw493@cornell.edu>
License: Copyright © 2023 Travis Wrightsman
        
        Permission is hereby granted, free of charge, to any person obtaining
        a copy of this software and associated documentation files (the
        “Software”), to deal in the Software without restriction, including
        without limitation the rights to use, copy, modify, merge, publish,
        distribute, sublicense, and/or sell copies of the Software, and to
        permit persons to whom the Software is furnished to do so, subject to
        the following conditions:
        
        The above copyright notice and this permission notice shall be
        included in all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
        EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
        MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
        NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
        LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
        OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
        WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
        
Project-URL: Homepage, https://github.com/twrightsman/watersnake
Project-URL: Bug Tracker, https://github.com/twrightsman/watersnake/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

# Watersnake

## Usage

```
>>> import watersnake
>>> aligner = watersnake.Aligner()
>>> aligner.align("ACTG", "ACTG")
'4M'
```

## Building the package from source

Watersnake uses [pixi](https://prefix.dev/docs/pixi/overview) for managing the build environment and tasks.

```
$ cd watersnake/
# Run the patch-conda-forge command only *once* after building a new Pixi environment since it modifies the WFA2-lib Conda package!
$ pixi run patch-conda-forge
$ pixi run twine-check
```
