add release workflow, update changelog, pypi upload (#15)

* add release workflow

* update changelog

* Bump version: 0.0.1 → 0.0.2

* update readme

Author: adamgayoso

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.0.1
+current_version = 0.0.2
 tag = True
 commit = True
 

.github/workflows/release.yaml

@@ -0,0 +1,38 @@
+name: Release
+
+on:
+    push:
+        tags:
+            - "*.*.*"
+
+jobs:
+    release:
+        name: Release
+        runs-on: ubuntu-latest
+        steps:
+            # will use ref/SHA that triggered it
+            - name: Checkout code
+              uses: actions/checkout@v3
+
+            - name: Set up Python 3.10
+              uses: actions/setup-python@v2
+              with:
+                  python-version: "3.10"
+            - name: Install pypa/build
+              run: >-
+                  python -m
+                  pip install
+                  build
+                  --user
+            - name: Build a binary wheel and a source tarball
+              run: >-
+                  python -m
+                  build
+                  --sdist
+                  --wheel
+                  --outdir dist/
+                  .
+            - name: Publish a Python distribution to PyPI
+              uses: pypa/gh-action-pypi-publish@release/v1
+              with:
+                  password: ${{ secrets.PYPI_API_TOKEN }}

CHANGELOG.md

@@ -8,8 +8,14 @@ and this project adheres to [Semantic Versioning][].
 [keep a changelog]: https://keepachangelog.com/en/1.0.0/
 [semantic versioning]: https://semver.org/spec/v2.0.0.html
 
-## [Unreleased]
+## 0.0.2 (2022-10-03)
 
 ### Added
 
--   Basic tool, preprocessing and plotting functions
+-   Jax Silhouette by @adamgayoso in #1
+-   Move silhouette to utils by @adamgayoso in #2
+-   Update README.md by @adamgayoso in #3
+-   Initial docs by @adamgayoso in #4
+-   Silhouette batch + labels by @adamgayoso in #5
+-   Add kmeans, nmi, ari metrics by @adamgayoso in #6
+-   Isolated labels + settings by @adamgayoso in #7

README.md

@@ -30,7 +30,13 @@ pip install scib-metrics
 ```
 -->
 
-1. Install the latest development version:
+1. Install the latest release on PyPI:
+
+```bash
+pip install scib-metrics
+```
+
+2. Install the latest development version:
 
 ```bash
 pip install git+https://github.com/yoseflab/scib-metrics.git@main

pyproject.toml

@@ -5,7 +5,7 @@ requires = ["hatchling"]
 
 [project]
 name = "scib_metrics"
-version = "0.0.1"
+version = "0.0.2"
 description = "Accelerated and Python-only scIB metrics"
 readme = "README.md"
 requires-python = ">=3.8"