Merge pull request #302 from sibson/mise-env-make-primary

build: use make as primary task runner; use mise only for env\n\n- Re…

Author: sibson

.mise.toml

@@ -0,0 +1,3 @@
+[tools]
+# Pin the Python version for local environments managed by mise
+python = "3.13"

DEVELOP.txt

@@ -1,17 +1,21 @@
 Testing
 ---------
- - use pyenv on OSX to manage multiple python versions
- 
-``` pip install -r requirements-dev.txt
+ - Recommended: use make for setup and running tests
+
+    make setup
+    make test
+
+ - Or use pyenv/pip manually on macOS to manage Python versions
+
+    pip install -r requirements-dev.txt
     python -m unittest discover tests
-```
 
 Release
 ---------
  - bump version and release to pypi
 
-    make version-NEWVERSION
-    make release
+    make release-check
+    VERSION='M.m.p' make release
 
  - create release in GitHub
 

Makefile.venv

@@ -76,11 +76,21 @@ Development
 --------------
 RedBeat is available on `GitHub <https://github.com/sibson/redbeat>`_
 
-Once you have the source you can run the tests with the following commands::
+Once you have the source you can run the tests with make (recommended)::
+
+    make setup
+    make test
+
+Or using pip directly::
 
     pip install -r requirements-dev.txt
     python -m unittest discover tests
 
+Optional: if you use mise to manage Python, it will read `.mise.toml` and install the pinned Python version. After that, still use make for tasks::
+
+    mise install
+    make setup && make test
+
 You can also quickly fire up a sample Beat instance with::
 
     celery beat --config exampleconf

README.rst

@@ -1,14 +1,19 @@
-.PHONY: upload release release-test release-tag build version
+.PHONY: upload release release-test release-tag build version setup lint test unittests docs clean veryclean clean-venv release-check
 
 REQUIREMENTS_TXT=requirements-dev.txt
 
 test: unittests
 
-lint: venv
-	$(VENV)/flake8 redbeat tests
+setup:
+	python -m pip install --upgrade pip
+	pip install -r requirements-dev.txt
+	pip install -e .
+
+lint:
+	flake8 redbeat tests
 
 build:
-	$(VENV)/python -m build
+	python -m pip install --upgrade build && python -m build
 
 release: release-check unittests release-tag
 release-check:
@@ -21,29 +26,30 @@ release-check:
 release-tag: TODAY:=$(shell date '+%Y-%m-%d')
 release-tag:
 ifndef VERSION
-	echo "usage: make release VERSION='M.m.p'"
+	@echo "usage: make release VERSION='M.m.p'" && false
 else
 	sed -i '' -e 's|version = .*|version = $(VERSION)|' setup.cfg
 	sed -i '' -e "s/unreleased/$(TODAY)/" CHANGES.txt
-	git ci -m"prepare for release of $(VERSION)" CHANGES.txt setup.cfg
+	git ci -m"prepare for release of $(VERSION)" CHANGES.txt setup.cfg || git commit -m"prepare for release of $(VERSION)" CHANGES.txt setup.cfg
 	git tag -a v$(VERSION) -m"release version $(VERSION)"
 	git push --tags
-	echo "$(VERSION)dev (unreleased)\n---------------------\n$(cat CHANGES.txt)\n  -\n\n" > CHANGES.txt
+	printf "%s\n%s\n%s\n  -\n" "$(VERSION)dev (unreleased)" "---------------------" "$$(cat CHANGES.txt)" > CHANGES.txt
 endif
 
 docs:
 	$(MAKE) -C docs/ html
 
-unittests: venv
-	$(VENV)/python -m unittest discover tests
+unittests:
+	python -m unittest discover tests
 
 clean:
 	rm -f dist/*
 	rm -rf docs/_build docs/_static docs/_templates
 
 veryclean: clean clean-venv
 
-include Makefile.venv
+clean-venv:
+	rm -rf .venv
 
 version:
 	@grep -m1 '^version' setup.cfg | sed 's/.*= *//'