split CI build / publish jobs

Author: modelflat

.github/workflows/release.yml

@@ -10,18 +10,35 @@ jobs:
   windows:
     runs-on: windows-latest
     steps:
-    - uses: actions/checkout@v3
-    - uses: PyO3/maturin-action@v1
+    - name: Checkout
+      uses: actions/checkout@v3
+    - name: Build wheels
+      uses: PyO3/maturin-action@v1
       with:
         command: build
         args: -m zbl_py/Cargo.toml --release -o dist --find-interpreter
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v3
+      with:
+        name: dist
+        path: dist
+  publish:
+    needs:
+    - windows
+    runs-on: ubuntu-latest
+    steps:
+    - name: Get artifacts
+      uses: actions/download-artifact@v2
+      with:
+        name: dist
+        path: dist
     - name: Release
       uses: softprops/action-gh-release@v1
       if: startsWith(github.ref, 'refs/tags/')
       with:
         files: dist/*
     - name: Publish package to PyPI
-      if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+      if: startsWith(github.ref, 'refs/tags')
       uses: pypa/gh-action-pypi-publish@release/v1
       with:
         password: ${{ secrets.PYPI_API_TOKEN }}

README.md

@@ -1,32 +1,37 @@
 # zbl
 
-`zbl` is a Rust and Python library which provides a very simple interface for Microsoft's `Windows.Graphics.Capture` API
-and makes it easy to integrate CV libraries (such as OpenCV) with desktop apps.
+`zbl` is a Rust and Python library which aims to make it easy to integrate CV libraries (such as OpenCV) with
+Windows Desktop apps for real-time processing. It does so by providing a simplified interface to 
+`Windows.Graphics.Capture`.
 
 **This library is not well-tested against corner cases, and was only verified to work for a 'happy path' scenarios, so beware of bugs!**
 
-## Installation
+## Python
 
-Download and install suitable wheel from [releases page](https://github.com/modelflat/zbl/releases).
+### Installation
 
-## Usage
+`pip install zbl`
 
-### Python
+Alternatively, you can install suitable wheel from [releases page](https://github.com/modelflat/zbl/releases).
+
+### Usage
 
 ```python
 from zbl import Capture
 
-with Capture('<window name>') as cap:
+with Capture('visual studio code') as cap:
     frame = next(cap.frames())
     print(frame.shape)
 ```
 
+The snippet above will capture a window which title contains the string `visual studio code`, take one frame (which is represented as a `numpy` array) and print its shape.
+
 To run an example using OpenCV's `highgui`:
 
 1. Install `opencv-python`
 2. Run `python -m zbl '<full or partial window name, case insensitive>'`
 
-### Rust
+## Rust
 
 See [examples](https://github.com/modelflat/zbl/tree/master/zbl/examples).
 Note: if you are getting OpenCV build errors when building the example, check out [how to build OpenCV rust bindings](https://github.com/twistedfall/opencv-rust#rust-opencv-bindings).

zbl_py/pyproject.toml

@@ -1,12 +1,10 @@
-[build-system]
-requires = ["maturin>=0.13,<0.14"]
-build-backend = "maturin"
-
 [project]
 name = "zbl"
-version = "0.0.1"
-license = { file = "../LICENSE.txt" }
+version = "0.0.3"
+readme = "../README.md"
 requires-python = ">=3.7"
+license = { file = "../LICENSE.txt" }
+keywords = ["windows", "d3d11", "window-capture", "graphics-capture", "cv"]
 dependencies = ["numpy"]
 classifiers = [
     "Development Status :: 3 - Alpha",
@@ -18,3 +16,7 @@ classifiers = [
 example = [
     "opencv-python~=4.6.0"
 ]
+
+[build-system]
+requires = ["maturin>=0.13,<0.14"]
+build-backend = "maturin"