API ReferenceΒΆ

The version of the wrapped skani library is stored in the SKANI_VERSION constant, accessible from the top-level namespace. The version of skani wrapped in this version of pyskani is v0.1.1.

Note

Versioning of wrapper libraries and bindings is not necessarily obvious. Since pyskani follows semantic versioning, it does not keep its version synchronized with skani in any way, treating it as any other dependency. The changelog will document updates, so it can be used to find a particular pyskani version to pin if a given skani release is wanted.

pyskani.Database

A database storing sketched genomes.

pyskani.Sketch

A sketched genome.

pyskani.Hit

A single hit found when querying a Database with a genome.