module: add Makefile for development commands

This commit is contained in:
cn 2020-08-06 22:01:50 +02:00 committed by Christian Nicolai
parent e36c38d950
commit 346ea6c0de
3 changed files with 30 additions and 2 deletions

View File

@ -13,5 +13,5 @@ install:
- poetry install
- poetry run pylint bme280
- poetry run pytest
- make lint
- make test

Makefile Normal file
View File

@ -0,0 +1,24 @@
SHELL := bash
.SHELLFLAGS := -eu -o pipefail -c
MAKEFLAGS += --warn-undefined-variables
MAKEFLAGS += --no-builtin-rules
.PHONY: all
all: lint test ## Run lint and test (default goal)
.PHONY: lint
lint: ## Lint all source code
poetry run pylint bme280
.PHONY: test
test: ## Run all tests
poetry run pytest
.PHONY: help
help: ## Print this help text
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-15s\033[0m %s\n", $$1, $$2}'

View File

@ -16,6 +16,10 @@ Consult the data sheet and see []( for clues how to use this libr
Not all functions of the chip are supported since I focused on the *forced mode* but data readout and parameter setting should work in *normal mode*, too. Please send pull requests for improvements and bug fixes!
## Develop
Run `make help` to find out about the available development commands.
## License
Python files in this repository are released under the [MIT license](LICENSE) except those parts from other sources which are indicated where appropriate in the files.