Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release v2.0 #61

Merged
merged 16 commits into from Oct 13, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 2 additions & 4 deletions .appveyor.yml
Expand Up @@ -2,12 +2,10 @@ environment:
global:
RANDOM_SEED: 0
matrix:
- PYTHON_MAJOR: 2
PYTHON_MINOR: 7
- PYTHON_MAJOR: 3
PYTHON_MINOR: 5
- PYTHON_MAJOR: 3
PYTHON_MINOR: 6
- PYTHON_MAJOR: 3
PYTHON_MINOR: 7

cache:
- .venv -> poetry.lock
Expand Down
1 change: 0 additions & 1 deletion .python-version

This file was deleted.

6 changes: 3 additions & 3 deletions .travis.yml
@@ -1,9 +1,9 @@
dist: xenial

language: python
python:
- 2.7
- 3.4
- 3.5
- 3.6
- 3.7

cache:
pip: true
Expand Down
6 changes: 6 additions & 0 deletions CHANGELOG.md
@@ -1,3 +1,9 @@
# 2.0 (2019-10-13)

- Deprecated `versions` in favor of `version` option.
- Deprecated `|` in favor of `||` for checking multiple versions.
- Dropped support for Python 2, Python 3.4, and Python 3.5

# 1.6.3 (2019-10-12)

- Fixed handling of programs that produce no output.
Expand Down
6 changes: 2 additions & 4 deletions Makefile
Expand Up @@ -61,18 +61,16 @@ poetry.lock: pyproject.toml
.PHONY: format
format: install
poetry run isort $(PACKAGES) --recursive --apply
# TODO: Enable black after dropping legacy Python support
# poetry run black $(PACKAGES)
poetry run black $(PACKAGES)
@ echo

.PHONY: check
check: install format ## Run formaters, linters, and static analysis
ifdef CI
git diff --exit-code
endif
poetry run mypy $(PACKAGES) --config-file=.mypy.ini
poetry run pylint $(PACKAGES) --rcfile=.pylint.ini
# TODO: Enable mypy after dropping legacy Python support
# poetry run mypy $(PACKAGES) --config-file=.mypy.ini
poetry run pydocstyle $(PACKAGES) $(CONFIG)

# TESTS #######################################################################
Expand Down
14 changes: 3 additions & 11 deletions README.md
Expand Up @@ -19,20 +19,12 @@ When onboarding new team members, ensuring their computer has everything needed

## Installation

Install verchew with pip:
Install `verchew` globally with pip:

```text
$ pip install verchew
```

or directly from the source code:

```text
$ git clone https://github.com/jacebrowning/verchew.git
$ cd verchew
$ python setup.py install
```

or embedded the script in your project using [this guide](https://verchew.readthedocs.io/en/latest/cli/vendoring/).

# Usage
Expand All @@ -50,7 +42,7 @@ version = 1.2
[Newer Working Program]

cli = working-program
versions = 4.1 | 4.2
version = 4.1 || 4.2
message = Version 4.x is required to get the special features.

[Broken Program]
Expand Down Expand Up @@ -85,7 +77,7 @@ Checking for Newer Working Program...

$ working-program --version
1.2.3
✘ EXPECTED: 4.1 | 4.2
✘ EXPECTED: 4.1 || 4.2
⭑ MESSAGE: Version 4.x is required to get the special features.

Checking for Broken Program...
Expand Down
6 changes: 3 additions & 3 deletions docs/cli/configuration.md
Expand Up @@ -9,7 +9,7 @@ Any of the following can be used as the `verchew` configuration filename:

# Version Arguments

If one of your system dependencies using an argument other than `--version` to display its version information, this can be changed in the configuration file using the `cli_version_arg` setting:
If one of your system dependencies uses an argument other than `--version` to display its version information, this can be changed in the configuration file using the `cli_version_arg` setting:

```ini
[Graphviz]
Expand All @@ -31,13 +31,13 @@ version = 16

# Multiple Versions

If your project can use multiple versions of a system dependency, use the `versions` setting and separate versions with the pipe character (`|`):
If your project can work with more than one version of a system dependency, separate them with a double pipe (`||`) symbol:

```ini
[Python]

cli = python
versions = Python 2 | Python 3
version = Python 2 || Python 3
```

# Optional Programs
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Expand Up @@ -3,7 +3,7 @@ site_description: Chews through your system dependencies, spitting out incompati
site_author: Jace Browning

repo_url: https://github.com/jacebrowning/verchew
edit_uri: https://github.com/jacebrowning/verchew/edit/jacebrowning/develop/docs
edit_uri: https://github.com/jacebrowning/verchew/edit/develop/docs

theme: readthedocs

Expand Down