obelist 0.0.0a2

A CLI tool for generating standard annotations for linting tools, tests, and so on (including support for GitHub Actions)

Obelist

A CLI tool for generating standard annotations for linting tools, tests, and so on (including support for GitHub Actions)

Table of contents:

• Installation
• Usage
• Appendix
  • Etymology

Installation

The obelist package is published to PyPI.

Because Obelist is primarily designed to be used as a CLI tool, we recommend that you install the package in an isolated virtual environment using pipx, like so:

$ pipx install obelist

However, if you want to install Obelist as a library, you can also install the package using pip:

$ pip install obelist

Usage

For basic usage information, run:

$ obelist

For more detailed help, run:

$ obelist --help

Appendix

Etymology

The obelus is a typographical mark used to "indicate erroneous or dubious content." The Oxford English Dictionary (OED) defines obelism as the "action or practice of marking something as spurious."

Obelist, then, serves as both a verbal noun and a play on words: the program's output is, essentially, a list of obeluses.