vmklib 0.4.7

Simplify project workflows by standardizing use of GNU Make.

vmklib (0.4.7)

Simplify project workflows by standardizing use of GNU Make.

This tool integrates with existing Makefile's with zero additional content or bootstrapping required.

There are many choices in technology or products for performing static analysis on source code, building test infrastructure, or managing local development environments. These are only a small subset of common, developer tasks when building software. This package intends to aggregate recipes (and their dependency relationships) for these tasks so that they can be integrated into a project without re-building this infrastructure. Lessons learned and improvements in each project can be back-propagated everywhere else with simple package updates.

Quick Links

• grip
• venv
• vmklib
• datazen
• pypi
• python

Command-line Options

$ ./venv3.8/bin/mk -h

usage: mk [-h] [--version] [-v] [-C DIR] [-p PREFIX] [-f FILE] [-P PROJ]
          [targets [targets ...]]

Simplify project workflows by standardizing use of GNU Make.

positional arguments:
  targets               targets to execute

optional arguments:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  -v, --verbose         set to increase logging verbosity
  -C DIR, --dir DIR     execute from a specific directory
  -p PREFIX, --prefix PREFIX
                        a prefix to apply to all targets
  -f FILE, --file FILE  file to source user-provided recipes from
  -P PROJ, --proj PROJ  project name for internal variable use

Targets

Note that the full invocation for a target's command is:

mk [options] <prefix>-<command> [ARG1=val1 ARG2=val2]

grip

Targets for rendering GitHub Markdown with grip.

Prefix: grip-

Optional Arguments

SECRETHUB_GRIP_PATH - The full path for the secrethub read command to source a GitHub personal access token from, requires secrethub.

GRIP_PORT - The host:port String to serve the rendered results on.

GRIP_ENV - Output file to write to for sourcing credentials.

Commands

check-env - Checks that GRIP_TOKEN is set in the environment, errors if not.

render - Serve README.md with grip.

venv

Targets for managing Python virtual environments.

Prefix: (no prefix)

Optional Arguments

PYTHON_VERSION - The version of Python to create a virtual environment for. (default: 3.8)

REQUIREMENTS_DIR - The location of the directory containing requirements files. (default: requirements in the project root)

REQ_FILES - Text files to install requirements from (using -r), in the requirements directory. (default: requirements.txt and dev_requirements.txt)

Commands

venv - Create or update the resolved virtual environment, if necessary.

venv-clean - Remove any virtual environments from the project root (or sub-directories).

vmklib

Targets related to this package, itself.

Prefix: mk-

Commands

upgrade - Upgrade (or install) vmklib in the resolved virtual environment.

sys-upgrade - Upgrade (or install) vmklib as a system or user package.

header - Print the Makefile header that should be used when integrating this package.

todo - Perform a case-insensitive search for todo in project directories.

datazen

Targets for use with the datazen package.

Prefix: dz-

Optional Arguments

DZ_DIR - Optionally override the -C argument.

DZ_MANIFEST - Optionally provide a non-default manifest file to -m.

DZ_VERBOSE - Setting this passes -v as an additional argument.

Commands

sync - Run dz, executing the default target.

clean - Run dz with -c to clean the cache.

describe - Run dz with -d to describe cache contents.

upgrade - Upgrade datazen in the resolved virtual environment with pip.

pypi

Targets for uploading packages to PyPI.

Prefix: pypi-

Optional Arguments

UPLOAD_ENV - Output file to write to for sourcing credentials.

SECRETHUB_PYPI_PATH - The full path for the secrethub read command to source a PyPI API token from, requires secrethub.

Commands

check-env - Enforces that TWINE_USERNAME and TWINE_PASSWORD are set in the environment, errors if not.

upload - Attempt to upload everything in dist to PyPI.

python

Targets for executing common, Python workflow tasks.

Prefix: python-

Optional Arguments

PY_LINT_ARGS - Set to override the default, adds the tests directory and PY_LINT_EXTRA_ARGS.

PY_LINT_EXTRA_ARGS - Set to add additional linting arguments.

PYTEST_ARGS - Set to override the default, additional pytest arguments.

PYTEST_EXTRA_ARGS - Add additional arguments to the default set.

PYTHON_COV_PORT - Port to host test-coverage HTML on (using http.server).

Commands

lint - Run pylint and flake8 against a project's package sources.

sa - Run mypy against a project's package sources.

sa-types - Run mypy without checking the result and attempt to install missing type/stub packages.

stubs - Run stubgen against a project's package sources.

format - Run black against a project's package sources.

format-check - Run black with the --check argument.

test - Run all of a project's tests with pytest.

test-% - Run project tests based on a search pattern (i.e. the -k option).

view - Attempt to open the test-coverage HTML with $BROWSER (environment variable).

host-coverage - Host test-coverage HTML locally, with the port specified by PYTHON_COV_PORT.

all - Run lint, sa and test in sequence.

clean - Remove compiled and cached files, test coverage, built package artifacts and other caches.

dist - Build sdist and bdist_wheel with setup.py in the project root.

upload - Use twine to upload the built package to PyPI.

editable - Install the project's package in editable mode (-e option) to the virtual environment.