Merge pull request #1 from brandur/brandur-development-instructions

Development instructions + link from README + additional make targets

Author: ewhauser

Makefile

@@ -1,2 +1,15 @@
+.PHONY: fmt
+fmt:
+	rye fmt
+
+.PHONY: lint
+lint:
+	rye lint
+
+.PHONY: test
+test:
+	rye test
+
+.PHONY: typecheck
 typecheck:
 	rye run mypy -p src.riverqueue

README.md

@@ -1,3 +1,7 @@
 # River client for Python
 
-An insert-only Python client for [River](https://github.com/riverqueue).
+An insert-only Python client for [River](https://github.com/riverqueue/river) packaged in the [`riverqueue` gem](https://rubygems.org/gems/riverqueue). Allows jobs to be inserted in Python and run by a Go worker, but doesn't support working jobs in Python.
+
+## Development
+
+See [development](./docs/development.md).

docs/development.md

@@ -0,0 +1,47 @@
+# riverqueue-python development
+
+## Install dependencies
+
+The project uses [Rye](https://github.com/astral-sh/rye) for its development toolchain and to run development targets. Install it with:
+
+```shell
+$ curl -sSf https://rye.astral.sh/get | bash
+```
+
+Or via Homebrew:
+
+```shell
+$ brew install rye
+```
+
+Then use it to set up a virtual environment:
+
+```shell
+$ rye sync
+```
+
+## Run tests
+
+```shell
+$ rye test
+```
+
+## Run lint
+
+```shell
+$ rye lint
+```
+
+## Run type check (Mypy)
+
+```shell
+$ make typecheck
+```
+
+## Format code
+
+```shell
+$ rye fmt
+```
+
+Rye uses [Ruff](https://github.com/astral-sh/ruff) under the hood for code formatting.