Skip to content

Commit

Permalink
initial rename to sourmash_plugin_branchwater
Browse files Browse the repository at this point in the history
  • Loading branch information
ctb committed Nov 29, 2023
1 parent 71053da commit cca04be
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 20 deletions.
4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[package]
name = "pyo3-branchwater"
name = "sourmash_plugin_branchwater"
version = "0.8.3"
edition = "2021"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[lib]
name = "pyo3_branchwater"
name = "pyo3_branchwater" # CTB: should we change this, too?
crate-type = ["cdylib"]

[dependencies]
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# pyo3_branchwater
# sourmash_plugin_branchwater

[![PyPI](https://img.shields.io/pypi/v/pyo3-branchwater)](https://pypi.org/project/pyo3-branchwater/)
[![PyPI](https://img.shields.io/pypi/v/sourmash_plugin_branchwater)](https://pypi.org/project/sourmash_plugin_branchwater/)

tl;dr Do fast and low-memory search/gather of many sourmash sketches
via a sourmash plugin.
Expand All @@ -13,7 +13,7 @@ This repo contains a PyO3-based Python wrapper around the
is a fast, low-memory and multithreaded application for searching very large
collections of
[FracMinHash sketches](https://www.biorxiv.org/content/10.1101/2022.01.11.475838v2)
as generated by [sourmash](sourmash.readthedocs.io/).
as generated by [sourmash](https://sourmash.readthedocs.io/).

For details, see the Rust code in `src/` and Python wrapper in `src/python/`.

Expand Down Expand Up @@ -77,10 +77,10 @@ This will make sure everything can be loaded properly.
The speed and functions of this code will probably be brought into
sourmash core in the future, most likely as part of
[sourmash#2230](https://github.com/sourmash-bio/sourmash/pull/2230).
However, in the meantime, this is a fun side project that makes use
of sourmash plugins and Rust to provide some fast functionality
that may be of use to some people, and it can serve as a testbed for
future sourmash functionality.
However, in the meantime, this is a fun and useful side project that
makes use of sourmash plugins and Rust to provide some fast
functionality, and it can serve as a testbed for future sourmash
functionality.

## Developer notes

Expand Down
18 changes: 9 additions & 9 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "pyo3-branchwater"
description = "fast search and gather extensions for sourmash"
name = "sourmash_plugin_branchwater"
description = "fast command-line extensions for sourmash"
readme = "README.md"
requires-python = ">=3.8"
classifiers = [
Expand All @@ -22,13 +22,13 @@ requires = ["maturin>=1.1.0,<2"]
build-backend = "maturin"

[project.entry-points."sourmash.cli_script"]
manysearch = "pyo3_branchwater:Branchwater_Manysearch"
multisearch = "pyo3_branchwater:Branchwater_Multisearch"
fastgather = "pyo3_branchwater:Branchwater_Fastgather"
fastmultigather = "pyo3_branchwater:Branchwater_Fastmultigather"
index = "pyo3_branchwater:Branchwater_Index"
check = "pyo3_branchwater:Branchwater_Check"
manysketch = "pyo3_branchwater:Branchwater_Manysketch"
manysearch = "sourmash_plugin_branchwater:Branchwater_Manysearch"
multisearch = "sourmash_plugin_branchwater:Branchwater_Multisearch"
fastgather = "sourmash_plugin_branchwater:Branchwater_Fastgather"
fastmultigather = "sourmash_plugin_branchwater:Branchwater_Fastmultigather"
index = "sourmash_plugin_branchwater:Branchwater_Index"
check = "sourmash_plugin_branchwater:Branchwater_Check"
manysketch = "sourmash_plugin_branchwater:Branchwater_Manysketch"


[tool.maturin]
Expand Down
File renamed without changes.
4 changes: 2 additions & 2 deletions src/python/tests/__init__.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
from pyo3_branchwater import pyo3_branchwater
pyo3_branchwater.set_global_thread_pool(4)
from sourmash_plugin_branchwater import sourmash_plugin_branchwater
sourmash_plugin_branchwater.set_global_thread_pool(4)

0 comments on commit cca04be

Please sign in to comment.