API Documentation

reqwire.helpers

Various helper utilities.

reqwire.helpers.cli

Helpers for command-line applications.

class reqwire.helpers.cli.ConsoleWriter(verbose=True)[source]

Facilitates writing formatted, informational messages to a TTY.

echo(message, *args, **kwargs)[source]

Wraps click.echo().

Parameters:
  • message – The message to write to stdout.
  • *args – Used to format message.
  • **kwargs – Used to format message.
error(message, *args, **kwargs)[source]

Prints an error message.

Parameters:
  • message – The message to write to stdout.
  • *args – Used to format message.
  • **kwargs – Used to format message.
fatal(message, *args, **kwargs)[source]

Prints a fatal message.

Parameters:
  • message – The message to write to stdout.
  • *args – Used to format message.
  • **kwargs – Used to format message.
info(message, *args, **kwargs)[source]

Prints an informational message.

Parameters:
  • message – The message to write to stdout.
  • *args – Used to format message.
  • **kwargs – Used to format message.
warn(message, *args, **kwargs)[source]

Prints a warning message.

Parameters:
  • message – The message to write to stdout.
  • *args – Used to format message.
  • **kwargs – Used to format message.
warning(message, *args, **kwargs)[source]

Prints a warning message.

Parameters:
  • message – The message to write to stdout.
  • *args – Used to format message.
  • **kwargs – Used to format message.
reqwire.helpers.cli.emojize(message, **kwargs)[source]

Wrapper around emoji.emojize() for Windows compatibility.

Emoji are not well supported under Windows. This function not only checks sys.platform, but the file /proc/version as well to prevent “emojification” on the Windows Subsystem for Linux (WSL, otherwise known as Ubuntu on Windows).

Parameters:
  • message – The format string. See emoji.emojize() for more information. Any emoji placeholders will be removed if Windows or WSL are detected.
  • **kwargs – Passed to emoji.emojize().

reqwire.helpers.requirements

reqwire.config

Provides configuration and configuration defaults.

reqwire.errors

Provides custom exception classes.

exception reqwire.errors.IndexUrlMismatchError[source]

Indicates a conflict between CLI and requirement source file.

exception reqwire.errors.ReqwireError[source]

Base class for all exceptions thrown by reqwire.

reqwire.scaffold