MRG: add more information about deps (#35)

* add more information about deps

* update Makefile and README

* add an environment yml

* update README

* add pandas

* bump version to 0.6.3

* update author list

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "pyo3-branchwater"
-version = "0.6.2"
+version = "0.6.3"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

Makefile

@@ -11,3 +11,13 @@ clean:
 
 test:
 	$(PYTHON) -m pytest
+
+wheel:
+	$(PYTHON) -m maturin build -r
+
+sdist:
+	rm -f target/wheels/pyo3_branchwater-*.tar.gz
+	$(PYTHON) -m maturin sdist
+
+upload_sdist: sdist
+	twine upload target/wheels/pyo3_branchwater-*.tar.gz

README.md

@@ -90,34 +90,54 @@ 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.
 
-## Develoer notes
+## Developer notes
 
+### Installing a development environment
+
+You'll need sourmash, rust, and [maturin](https://github.com/PyO3/maturin).
+
+A simple way to get up and running is to run:
+```
+mamba env create -n branchwatever-dev -f environment.yml
+```
+in the top directory of the repo, and then activate the environment and
+install in editable mode:
+```
+mamba activate branchwater-dev
+pip install -e .
+```
+
+### Running the tests locally
+
+Executing:
 ```
 make test
 ```
 will run the Python tests.
 
 ### Generating a release
 
-Bump version number in `Cargo.toml` and push.
+1. Bump version number in `Cargo.toml` and run `make` to update `Cargo.lock`.
+Then commit and push to `origin/main`.
 
-Make a new release on github.
+2. Make a new release on github with a matching version tag.
 
-Then pull, and:
+3. Then pull, and:
 
 ```
-rm -fr target/wheels/
-maturin sdist
+make sdist
+make upload_sdist
 ```
 
-followed by `twine upload target/wheels/pyo3_branchwater-*.tar.gz`
+to create a new release on PyPI.
 
 ### Building wheels
 
-You can build a wheel for your current platform with:
+You can build a release wheel for your current platform with:
 ```
-maturin build
+make wheel
 ```
+and it will be placed under `target/wheels/`.
 
 ---
 
@@ -127,7 +147,7 @@ This software is under the AGPL license. Please see [LICENSE.txt](LICENSE.txt).
 
 ## Authors
 
-Luiz Irber
-C. Titus Brown
-Mohamed Abuelanin
-N. Tessa Pierce-Ward
+* Luiz Irber
+* C. Titus Brown
+* Mohamed Abuelanin
+* N. Tessa Pierce-Ward

environment.yml

@@ -0,0 +1,12 @@
+name: branchwater-dev
+channels:
+    - conda-forge
+    - bioconda
+    - defaults
+dependencies:
+    - sourmash>=4.8.3,<5
+    - pip
+    - rust
+    - maturin>=1,<2
+    - pytest
+    - pandas

pyproject.toml

@@ -7,7 +7,8 @@ classifiers = [
     "Programming Language :: Rust",
     "Programming Language :: Python :: Implementation :: CPython",
     "Programming Language :: Python :: Implementation :: PyPy",
-]
+    ]
+dependencies = ["sourmash>=4.8.3,<5"]
 
 [build-system]
 requires = ["maturin>=1.1.0,<2"]