From cca04be832ae2f8fbf63f0b1206b0d08da9ccdd8 Mon Sep 17 00:00:00 2001 From: "C. Titus Brown" Date: Wed, 29 Nov 2023 07:46:36 -0800 Subject: [PATCH] initial rename to sourmash_plugin_branchwater --- Cargo.toml | 4 ++-- README.md | 14 +++++++------- pyproject.toml | 18 +++++++++--------- .../__init__.py | 0 src/python/tests/__init__.py | 4 ++-- 5 files changed, 20 insertions(+), 20 deletions(-) rename src/python/{pyo3_branchwater => sourmash_plugin_branchwater}/__init__.py (100%) diff --git a/Cargo.toml b/Cargo.toml index 24f8f541..f25312d8 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -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] diff --git a/README.md b/README.md index 22c1d1b5..edebb161 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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/`. @@ -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 diff --git a/pyproject.toml b/pyproject.toml index 9ea017f2..9f11a47f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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 = [ @@ -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] diff --git a/src/python/pyo3_branchwater/__init__.py b/src/python/sourmash_plugin_branchwater/__init__.py similarity index 100% rename from src/python/pyo3_branchwater/__init__.py rename to src/python/sourmash_plugin_branchwater/__init__.py diff --git a/src/python/tests/__init__.py b/src/python/tests/__init__.py index ac5ae682..c1a35185 100644 --- a/src/python/tests/__init__.py +++ b/src/python/tests/__init__.py @@ -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)