Metadata-Version: 2.1
Name: obelist
Version: 0.0.0a2
Summary: A CLI tool for generating standard annotations for linting tools, tests, and so on (including support for GitHub Actions)
Home-page: https://github.com/nomiro/obelist
Keywords: linting,continuous-integration,annotations,tests,github-actions,problem-matcher
Author: Naomi Rose
Author-email: 23469+nomiro@users.noreply.github.com
Requires-Python: >=3.7,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Utilities
Requires-Dist: PyYAML (>=6.0,<7.0)
Requires-Dist: charset-normalizer (>=2.0.7,<3.0.0)
Requires-Dist: click (>=8.0.3,<9.0.0)
Requires-Dist: inflection (>=0.5.1,<0.6.0)
Requires-Dist: lxml (>=4.6.4,<5.0.0)
Requires-Dist: natsort (>=8.0.0,<9.0.0)
Requires-Dist: pastel (>=0.2.1,<0.3.0)
Requires-Dist: pyjq (>=2.5.2,<3.0.0)
Requires-Dist: pyroma (>=3.2,<4.0)
Requires-Dist: sh (>=1.14.2,<2.0.0)
Requires-Dist: urlextract (>=1.4.0,<2.0.0)
Requires-Dist: vulture (>=2.3,<3.0)
Requires-Dist: wrapt (>=1.13.3,<2.0.0)
Project-URL: Repository, https://github.com/nomiro/obelist
Description-Content-Type: text/markdown

# Obelist

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

[![Build][action-build-img]][action-build]

**Table of contents:**

- [Installation](#installation)
- [Usage](#usage)
- [Appendix](#appendix)
  - [Etymology](#etymology)

## Installation

The [obelist][pypi-obelist] package is published to [PyPI][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][pipx], like so:

```console
$ pipx install obelist
```

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

```console
$ pip install obelist
```

## Usage

For basic usage information, run:

```console
$ obelist
```

For more detailed help, run:

```console
$ 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_.

[action-build-img]: https://github.com/nomiro/obelist/actions/workflows/build.yaml/badge.svg
[action-build]: https://github.com/nomiro/obelist/actions/workflows/build.yaml
[obelism]: https://en.wikipedia.org/wiki/Obelism
[obelus]: https://en.wikipedia.org/wiki/Obelus
[pip]: https://pip.pypa.io/en/stable/
[pipx]: https://pypa.github.io/pipx/
[pypi-obelist]: https://pypi.org/project/obelist
[pypi]: https://pypi.org/

