Merge pull request #71 from jacebrowning/release/v3.1

Release v3.1

Author: jacebrowning

.appveyor.yml

@@ -6,6 +6,8 @@ environment:
       PYTHON_MINOR: 6
     - PYTHON_MAJOR: 3
       PYTHON_MINOR: 7
+    - PYTHON_MAJOR: 3
+      PYTHON_MINOR: 8
 
 cache:
   - .venv -> poetry.lock

.gitignore

@@ -3,6 +3,7 @@
 *.egg-info
 __pycache__
 .ipynb_checkpoints
+setup.py
 
 # Temporary OS files
 Icon*

.pylint.ini

@@ -127,7 +127,11 @@ disable=
     wildcard-import,
     unused-wildcard-import,
     singleton-comparison,
+    bad-continuation,
     global-statement,
+    import-error,
+    no-name-in-module,
+    ungrouped-imports,
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option

.python-version

@@ -1,2 +1,2 @@
-3.7.5
+3.8.2
 2.7.14

.travis.yml

@@ -4,6 +4,7 @@ language: python
 python:
   - 3.6
   - 3.7
+  - 3.8
 
 cache:
   pip: true

.verchew.ini

@@ -6,17 +6,17 @@ version = GNU Make
 [Python 2]
 
 cli = python2
-version = Python 2.7
+version = 2.7
 
 [Python 3]
 
 cli = python3
-version = Python 3
+version = 3
 
 [Poetry]
 
 cli = poetry
-version = 1.0 || 0.12
+version = 1
 
 [Graphviz]
 

CHANGELOG.md

@@ -1,3 +1,9 @@
+# 3.1 (2020-04-18)
+
+- Added support for unicode characters in Python 3.8.
+- Added `--vendor PATH` command to download the program for offline use.
+- Updated `--quiet` output to include actual program versions.
+
 # 3.0.2 (2020-01-06)
 
 - Removed type annotations to continue supporting legacy Python.
@@ -86,4 +92,4 @@
 
 # 0.1 (2016-10-17)
 
- - Initial release.
+- Initial release.

CONTRIBUTING.md

@@ -67,6 +67,20 @@ The CI server will report overall build status:
 $ make ci
 ```
 
+# Demo Tasks
+
+Run the program:
+
+```text
+$ make run
+````
+
+Launch an IPython session:
+
+```text
+$ make ipython
+```
+
 # Release Tasks
 
 Release to PyPI:

Makefile

@@ -17,7 +17,7 @@ VIRTUAL_ENV ?= .venv
 all: install
 
 .PHONY: ci
-ci: check test ## Run all tasks that determine CI status
+ci: format check test mkdocs ## Run all tasks that determine CI status
 
 .PHONY: watch
 watch: install .clean-test ## Continuously run all CI tasks when files chanage
@@ -27,25 +27,25 @@ watch: install .clean-test ## Continuously run all CI tasks when files chanage
 run: install
 	poetry run python $(PACKAGE)/__main__.py
 
-.PHONY: demo ## Run the example
-demo:
-	cd examples && make doctor
+.PHONY: ipython ## Launch an IPython session
+ipython: install
+	poetry run ipython --ipython-dir=notebooks
 
-# SYSTEM DEPENDENCIES ##########################################################
+# SYSTEM DEPENDENCIES #########################################################
 
 .PHONY: doctor
 doctor:  ## Confirm system dependencies are available
-	verchew/script.py
+	bin/verchew
 
-# PROJECT DEPENDENCIES #########################################################
+# PROJECT DEPENDENCIES ########################################################
 
 DEPENDENCIES := $(VIRTUAL_ENV)/.poetry-$(shell bin/checksum pyproject.toml poetry.lock)
 
 .PHONY: install
 install: $(DEPENDENCIES) .cache
 
 $(DEPENDENCIES): poetry.lock
-	@ poetry config virtualenvs.in-project true || poetry config settings.virtualenvs.in-project true
+	@ poetry config virtualenvs.in-project true
 	poetry install
 	@ touch $@
 
@@ -62,8 +62,8 @@ endif
 
 .PHONY: format
 format: install
-	poetry run isort $(PACKAGES) --recursive --apply
-	poetry run black $(PACKAGES)
+	poetry run isort $(PACKAGES) notebooks --recursive --apply
+	poetry run black $(PACKAGES) notebooks
 	@ echo
 
 .PHONY: check
@@ -81,8 +81,8 @@ RANDOM_SEED ?= $(shell date +%s)
 FAILURES := .cache/v/cache/lastfailed
 
 PYTEST_OPTIONS := --random --random-seed=$(RANDOM_SEED)
-ifdef DISABLE_COVERAGE
-PYTEST_OPTIONS += --no-cov --disable-warnings
+ifndef DISABLE_COVERAGE
+PYTEST_OPTIONS += --cov=$(PACKAGE)
 endif
 PYTEST_RERUN_OPTIONS := --last-failed --exitfirst
 
@@ -131,9 +131,9 @@ $(MKDOCS_INDEX): docs/requirements.txt mkdocs.yml docs/*.md
 	@ cd docs/about && ln -sf ../../LICENSE.md license.md
 	poetry run mkdocs build --clean --strict
 
-# Workaround: https://github.com/rtfd/readthedocs.org/issues/5090
 docs/requirements.txt: poetry.lock
 	@ poetry run pip freeze -qqq | grep mkdocs > $@
+	@ poetry run pip freeze -qqq | grep Pygments >> $@
 
 .PHONY: uml
 uml: install docs/*.png
@@ -142,8 +142,8 @@ docs/*.png: $(MODULES)
 	- mv -f classes_$(PACKAGE).png docs/classes.png
 	- mv -f packages_$(PACKAGE).png docs/packages.png
 
-.PHONY: mkdocs-live
-mkdocs-live: mkdocs
+.PHONY: mkdocs-serve
+mkdocs-serve: mkdocs
 	eval "sleep 3; bin/open http://127.0.0.1:8000" &
 	poetry run mkdocs serve
 

README.md

@@ -15,14 +15,20 @@ When onboarding new team members, ensuring their computer has everything needed
 
 ## Requirements
 
-* Python 2.7+ or Python 3.3+
+- Python 2.7+ or Python 3.3+
 
 ## Installation
 
-Install `verchew` globally with pip:
+Install `verchew` globally with [pipx](https://pipxproject.github.io/pipx/installation/) (or pip):
 
 ```text
-$ pip install verchew
+$ pipx install verchew
+```
+
+or add it to your [Poetry](https://poetry.eustace.io/) project:
+
+```text
+$ poetry add verchew
 ```
 
 or embedded the script in your project using [this guide](https://verchew.readthedocs.io/en/latest/cli/vendoring/).
@@ -78,7 +84,7 @@ Checking for Newer Working Program...
 $ working-program --version
 1.2.3
 ✘ EXPECTED: 4.1 || 4.2
-⭑ MESSAGE: Version 4.x is required to get the special features.
+䷉ MESSAGE: Version 4.x is required to get the special features.
 
 Checking for Broken Program...
 
@@ -90,13 +96,13 @@ Checking for Optional Missing Program...
 
 $ missing-program --version
 sh: command not found: missing-program
-⚠ EXPECTED: 1.2.3
+▴ EXPECTED (OPTIONAL): 1.2.3
 
 Checking for Missing Program...
 
 $ missing-program --version
 sh: command not found: missing-program
 ✘ EXPECTED: 1.2.3
 
-Results: ✔ ✘ ✘ ⚠ ✘
+Results: ✔ ✘ ✘ ▴ ✘
 ```