Update makefile and travis config (#212)

Author: satterly

.env

@@ -0,0 +1,2 @@
+PROJECT=alertaclient
+COMPOSE_PROJECT_NAME=sdk

.pre-commit-config.yaml

@@ -1,4 +1,8 @@
 repos:
+-   repo: https://github.com/pre-commit/mirrors-autopep8
+    rev: v1.5.1
+    hooks:
+    -   id: autopep8
 -   repo: https://github.com/pre-commit/pre-commit-hooks.git
     rev: v2.5.0
     hooks:
@@ -22,17 +26,13 @@ repos:
         args: ['--django']
     -   id: requirements-txt-fixer
     -   id: trailing-whitespace
--   repo: https://github.com/pre-commit/mirrors-autopep8
-    rev: v1.5.1
-    hooks:
-    -   id: autopep8
 -   repo: https://github.com/asottile/pyupgrade
-    rev: v2.1.1
+    rev: v1.27.0
     hooks:
     -   id: pyupgrade
         args: ['--py3-plus']
 -   repo: https://github.com/asottile/seed-isort-config
-    rev: v2.1.1
+    rev: v1.9.4
     hooks:
     -   id: seed-isort-config
 -   repo: https://github.com/pre-commit/mirrors-isort

.travis.yml

@@ -7,21 +7,42 @@ python:
   - "3.5"
   - "3.6"
   - "3.7"
+  - "3.8"
+
+services:
+  - docker
 
 install:
   - pip install -r requirements.txt
   - pip install -r requirements-dev.txt
   - pip install .
 
-
 script:
-  - make test.unit
-  - make test.integration
+  - pytest --cov=alertaclient tests/unit
 
 stages:
-  - lint
+  - Hooks
+  - Checks
+  - Test
+  - Integration
 
 jobs:
   include:
-    - stage: lint
-      script: make lint
+    - stage: Hooks
+      name: Pre-commit
+      script: pre-commit run -a
+    - stage: Checks
+      name: Lint
+      script: pylint --rcfile pylintrc alertaclient
+    - name: Type Check
+      script: python -m mypy alertaclient/
+    - stage: Integration
+      name: Integration Test
+      script:
+      - docker-compose -f docker-compose.ci.yaml build sut
+      - docker-compose -f docker-compose.ci.yaml up --exit-code-from sut
+      - docker-compose -f docker-compose.ci.yaml rm --stop --force
+
+
+after_success:
+  - coveralls

Makefile

@@ -1,62 +1,113 @@
 
-PYTHON=python
-VERSION=`cut -d "'" -f 2 alertaclient/version.py`
+VENV=venv
+PYTHON=$(VENV)/bin/python
+PIP=$(VENV)/bin/pip --disable-pip-version-check
+PYLINT=$(VENV)/bin/pylint
+MYPY=$(VENV)/bin/mypy
+BLACK=$(VENV)/bin/black
+TOX=$(VENV)/bin/tox
+PYTEST=$(VENV)/bin/pytest
+PRE_COMMIT=$(VENV)/bin/pre-commit
+TWINE=$(VENV)/bin/twine
+GIT=git
+
 .DEFAULT_GOAL:=help
 
+-include .env .env.local .env.*.local
+
+ifndef PROJECT
+$(error PROJECT is not set)
+endif
+
+VERSION=$(shell cut -d "'" -f 2 $(PROJECT)/version.py)
+
+PKG_SDIST=dist/*-$(VERSION).tar.gz
+PKG_WHEEL=dist/*-$(VERSION)-*.whl
+
 all:	help
 
-## init			- Initialise environment.
-init:
-	pip install -r requirements.txt --upgrade
-	pip install -e .
+$(PIP):
+	python3 -m venv $(VENV)
 
-## dev			- Initialise dev environment.
-dev:
-	pip install -r requirements-dev.txt --upgrade
-	pre-commit install
-	pre-commit autoupdate
+$(PYLINT): $(PIP)
+	$(PIP) install pylint
 
-## hooks			- Run pre-commit hooks.
-hooks:
-	pre-commit run --all-files
+$(MYPY): $(PIP)
+	$(PIP) install mypy
 
-## lint			- Lint and type checking.
-lint:
-	@pip -q install pylint
-	pylint --rcfile pylintrc alertaclient
-	@pip -q install mypy==0.620
-	mypy alertaclient/
+$(BLACK): $(PIP)
+	$(PIP) install black
 
-## clean			- Clean source.
-clean:
-	find . -name "*.pyc" -exec rm {} \;
-	rm -Rf build dist *.egg-info
+$(TOX): $(PIP)
+	$(PIP) install tox
+
+$(PYTEST): $(PIP)
+	$(PIP) install pytest
+
+$(PRE_COMMIT): $(PIP)
+	$(PIP) install pre-commit
+
+$(TWINE): $(PIP)
+	$(PIP) install wheel twine
 
-## test.unit		- Run unit tests.
-test.unit:
-	pip install coveralls
-	pytest --cov=alertaclient tests/unit
+ifdef TOXENV
+toxparams?=-e $(TOXENV)
+endif
 
-## test.integration	- Run integration tests.
-test.integration:
-	docker-compose -f docker-compose.ci.yaml build sut
-	docker-compose -f docker-compose.ci.yaml up --exit-code-from sut
-	docker-compose -f docker-compose.ci.yaml rm --stop --force
+## format			- Code formatter.
+format: $(BLACK)
+	$(BLACK) -l120 -S -v $(PROJECT)
+
+## lint			- Lint and type checking.
+lint: $(PYLINT) $(MYPY) $(BLACK)
+	$(PYLINT) --rcfile pylintrc $(PROJECT)
+	$(MYPY) $(PROJECT)/
+	$(BLACK) -l120 -S --check -v $(PROJECT) || true
+
+## hooks			- Run pre-commit hooks.
+hooks: $(PRE_COMMIT)
+	$(PRE_COMMIT) run -a
+
+## test			- Run unit tests.
+test: $(TOX) $(PYTEST)
+	$(TOX) $(toxparams)
 
 ## run			- Run application.
 run:
-	alerta top
+	alertad
 
 ## tag			- Git tag with current version.
 tag:
-	git tag -a v$(VERSION) -m v$(VERSION)
-	git push --tags
+	$(GIT) tag -a v$(VERSION) -m "version $(VERSION)"
+	$(GIT) push --tags
+
+## build			- Build package.
+build: $(PKG_SDIST) $(PKG_WHEEL)
+$(PKG_SDIST):
+	$(PYTHON) setup.py sdist
+$(PKG_WHEEL):
+	$(PYTHON) setup.py bdist_wheel
 
 ## upload			- Upload package to PyPI.
-upload:
-	$(PYTHON) setup.py sdist bdist_wheel
-	twine upload dist/*
+upload: $(TWINE)
+	$(TWINE) upload dist/*
+
+## clean			- Clean source.
+clean:
+	find . -name "*.pyc" -exec rm {} \;
+	rm -Rf build dist *.egg-info
 
 ## help			- Show this help.
 help: Makefile
+	@echo ''
+	@echo 'Usage:'
+	@echo '  make [TARGET]'
+	@echo ''
+	@echo 'Targets:'
 	@sed -n 's/^##//p' $<
+	@echo ''
+
+	@echo 'Add project-specific env variables to .env file:'
+	@echo 'PROJECT=$(PROJECT)'
+
+.PHONY: help lint test build sdist wheel clean all

requirements-dev.txt

@@ -1,6 +1,9 @@
-mypy==0.620
+mypy
 pre-commit
+pylint
 pytest
 pytest-cov
+python-dotenv
 requests_mock
 twine
+wheel

tox.ini

@@ -0,0 +1,14 @@
+[tox]
+envlist = py36,py37,py38
+skip_missing_interpreters=true
+
+[testenv]
+deps =
+  pytest
+  requests_mock
+
+commands = pytest -s {posargs} tests/unit/
+#passenv = *
+setenv =
+  ALERTA_CONF_FILE =
+  ALERTA_DEFAULT_PROFILE =