Skip to content

Commit

Permalink
[MRG] update the sourmash __init__.py docstring (#1364)
Browse files Browse the repository at this point in the history
* update the sourmash __init__.py docstring

* add __all__
  • Loading branch information
ctb authored Mar 9, 2021
1 parent 1e96920 commit 001cd35
Showing 1 changed file with 28 additions and 6 deletions.
34 changes: 28 additions & 6 deletions src/sourmash/__init__.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,34 @@
#! /usr/bin/env python
"""
An implementation of a MinHash bottom sketch, applied to k-mers in DNA.
"""A library for computing hash sketches from DNA sequences, comparing
them to each other, and plotting the results.
Public API:
load_file_as_signatures(...) - load `[SourmashSignature, ]` from filename
load_file_as_index(...) - load collections of `SourmashSignature`s
save_signatures(...) - save `[SourmashSignature, ]`
class SourmashSignature - one or more hash sketches
class MinHash - hash sketch class
Please see https://sourmash.readthedocs.io/en/latest/api.html for API docs.
The sourmash code is available at github.com/dib-lab/sourmash/ under the
BSD 3-Clause license.
"""
import re
import math
import os
from deprecation import deprecated

__all__ = ['MinHash', 'SourmashSignature',
'load_one_signature',
'SourmashSignature',
'load_file_as_index',
'load_file_as_signatures',
'save_signatures',
'create_sbt_index',
'load_signatures', # deprecated - remove in 5.0
'load_sbt_index', # deprecated - remove in 5.0
'search_sbt_index', # deprecated - remove in 5.0
]

from ._lowlevel import ffi, lib

ffi.init_once(lib.sourmash_init, "init")
Expand Down

0 comments on commit 001cd35

Please sign in to comment.