4b469eaa66
Start of the CI/CD workflow for the python library and actor. Covered: - multiple python versions with Tox (3.10+) and pytest - Docs eventually with mkdocs (commented out for now) - Linting and formatting with Ruff and prettier - Codecov - include the mypy checks when the mypy errors are resolved.
54 lines
1.5 KiB
Makefile
54 lines
1.5 KiB
Makefile
.PHONY: install
|
|
install: ## Install the poetry environment and install the pre-commit hooks
|
|
@echo "🚀 Creating virtual environment using pyenv and poetry"
|
|
@poetry install
|
|
@poetry run pre-commit install
|
|
@poetry shell
|
|
|
|
.PHONY: check
|
|
check: ## Run code quality tools.
|
|
@echo "🚀 Checking Poetry lock file consistency with 'pyproject.toml': Running poetry check --lock"
|
|
@poetry check --lock
|
|
@echo "🚀 Linting code: Running pre-commit"
|
|
@poetry run pre-commit run -a
|
|
@echo "🚀 Static type checking: Running mypy"
|
|
@poetry run mypy $(git ls-files '*.py')
|
|
|
|
.PHONY: test
|
|
test: ## Test the code with pytest
|
|
@echo "🚀 Testing code: Running pytest"
|
|
@poetry run pytest -v --cov --cov-config=pyproject.toml --cov-report=xml
|
|
|
|
.PHONY: build
|
|
build: clean-build ## Build wheel file using poetry
|
|
@echo "🚀 Creating wheel file"
|
|
@poetry build
|
|
|
|
.PHONY: clean
|
|
clean: ## clean build artifacts
|
|
@rm -rf dist
|
|
|
|
.PHONY: publish
|
|
publish: ## publish a release to pypi.
|
|
@echo "🚀 Publishing: Dry run."
|
|
@poetry config pypi-token.pypi $(PYPI_TOKEN)
|
|
@poetry publish --dry-run
|
|
@echo "🚀 Publishing."
|
|
@poetry publish
|
|
|
|
.PHONY: build-and-publish
|
|
build-and-publish: build publish ## Build and publish.
|
|
|
|
.PHONY: docs-test
|
|
docs-test: ## Test if documentation can be built without warnings or errors
|
|
@poetry run mkdocs build -s
|
|
|
|
.PHONY: docs
|
|
docs: ## Build and serve the documentation
|
|
@poetry run mkdocs serve
|
|
|
|
.PHONY: help
|
|
help:
|
|
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
|
|
|
|
.DEFAULT_GOAL := help
|