Skip to content

Latest commit

 

History

History
140 lines (99 loc) · 2.77 KB

developer.md

File metadata and controls

140 lines (99 loc) · 2.77 KB
Raw

Developer notes

Developer installation of sourmash_plugin_branchwater

1. Install necessary dependencies

You'll need Rust, Python, and maturin to build the branchwater plugin, and sourmash to run to run it.

There is a list of the necessary conda packages in environment.yml. To install them in a new conda environment, run:

mamba env create -n branchwater -f environment.yml

and then activate the conda environment:

conda activate branchwater

2. Install sourmash_plugin_branchwater.

Install this repo in editable mode:

pip install -e .

3. Fun, profit.

You can now use the plugin in "developer" mode, where any changes you make to the Python source code will be reflected in the installed version. To update the installed version with changes to the Rust code, you'll need to compile the Rust code with:

maturin develop

Running the tests locally

Executing:

make test

will run the Python tests.

Generating a release

  1. Bump version number in Cargo.toml and run make to update Cargo.lock. Then commit and push to origin/main.

  2. Make a new release on github with a matching version tag.

  3. Then pull, and:

make sdist
make upload_sdist

to create a new release on PyPI.

Building wheels

You can build a release wheel for your current platform with:

make wheel

and it will be placed under target/wheels/.

Develop using pixi

1. Install pixi

Follow the install instructions for pixi. For Linux and macOS it will most likely be

curl -fsSL https://pixi.sh/install.sh | bash

2. Install sourmash_plugin_branchwater.

Install this repo in editable mode:

pixi run develop

3. Activate the development shell

The development shell with all dependencies installed can be activated with

pixi shell

You can also run commands in the environment without activating it with

pixi run CMD

4. Fun, profit.

You can now use the plugin in "developer" mode, where any changes you make to the Python source code will be reflected in the installed version. To update the installed version with changes to the Rust code, you'll need to compile the Rust code with:

pixi run develop

Running the tests locally

Executing:

pixi run test

will run the Python tests.

Generating a release

  1. Bump version number in Cargo.toml and run make to update Cargo.lock. Then commit and push to origin/main.

  2. Make a new release on github with a matching version tag.

  3. Then pull, and:

pixi run sdist
pixi run upload_sdist

to create a new release on PyPI.

Building wheels

You can build a release wheel for your current platform with:

pixi run wheel

and it will be placed under target/wheels/.