.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 lock --check" @poetry check --lock @echo "Linting code: Running pre-commit" @poetry run pre-commit run -a @echo "Static type checking: Running mypy" @poetry run mypy . @echo "Checking for obsolete dependencies: Running deptry" @poetry run deptry . .PHONY: test test: ## Test the code with pytest @echo "Testing code: Running pytest" @poetry run pytest --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-build clean-build: ## 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 python3 -m sphinx docs/ docs/_build -W .PHONY: docs docs: ## Build and serve the documentation @poetry run python3 -m sphinx docs docs/_build -b html .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