mcpq-python/Makefile at main · mcpq/mcpq-python · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
.PHONY: show_docs live_docs all docs proto nbt_lark test_local test_local_server test_full dist upload

# some instructions and setup from the following blog:
# https://dmltquant.github.io/ply_sphinx_docs_github_pages/README.html#step-01-project-folder

show_docs:
	@echo "Serving ./docs on http://127.0.0.1:8000/"
	@python3 -m http.server 8000 --bind 127.0.0.1 --directory ./docs

live_docs: | docs show_docs

all: | dist docs

docs:
	rm -rf docs
	rm -rf docsource/_autosummary
	rm -rf docsource/_build
	mkdir ./docs && touch ./docs/.nojekyll
	@make -C ./docsource html
	@cp -a ./docsource/_build/html/. ./docs

proto:
	python3 -m grpc_tools.protoc --version
	@echo "Make sure to have the correct version of grpcio and grpcio-tools installed, namely the minimal version specified in pyproject.toml"
	python3 -m grpc_tools.protoc --proto_path=proto --python_out=mcpq/_proto --grpc_python_out=mcpq/_proto proto/minecraft.proto
	@echo Run 'nox' to make sure your dependencies are still compatible

nbt_lark:
	python3 -m lark.tools.standalone --maybe_placeholders mcpq/nbt/snbt_and_component.lark -o mcpq/nbt/_snbt_and_component.py

test_local:
	pytest --without-integration tests

test_local_server:
	pytest tests

test_full:
	nox

dist:
	rm -rf dist build *.egg-info
	python3 -m build
	python3 -m twine check dist/*

upload:
	@test -f ~/.pypirc || echo "~/.pypirc does not exist, add PyPi and TestPyPi tokens!"
	@test -f ~/.pypirc
	@test -f /tmp/mcpq_warnup || echo "Do NOT forget to first bump the version (manually), then 'make all', then 'git commit' (to commit docs)!"
	@test -f /tmp/mcpq_warnup || (touch /tmp/mcpq_warnup && test)
	python3 -m twine check dist/*
	@test ! -f /tmp/mcpq_testup || echo "Package will now be uploaded to REAL PyPi!"
	@test -f /tmp/mcpq_testup || echo "Package will first be uploaded to TestPyPi!"
	@echo "Are you sure you want to upload?"
	@echo "(Upload will start in 10 seconds, abort with Ctrl+C...)"
	@sleep 10
	@test ! -f /tmp/mcpq_testup || python3 -m twine upload dist/*
	@test -f /tmp/mcpq_testup || python3 -m twine upload --repository testpypi dist/*
	@test -f /tmp/mcpq_testup || echo "remember to try to install the package with: (uv) pip install (--index-strategy unsafe-best-match) --index-url https://pypi.org/simple --extra-index-url https://test.pypi.org/simple mcpq(==NEW_VERSION)"
	@rm /tmp/mcpq_testup 2> /dev/null || touch /tmp/mcpq_testup