https://github.com/nomicode/wip-lintfree
A CLI tool for generating standard annotations for linting tools, tests, and so on (including support for GitHub Actions)
https://github.com/nomicode/wip-lintfree
annotations continuous-integration github-actions linting problem-matcher tests
Last synced: 3 months ago
JSON representation
A CLI tool for generating standard annotations for linting tools, tests, and so on (including support for GitHub Actions)
- Host: GitHub
- URL: https://github.com/nomicode/wip-lintfree
- Owner: nomicode
- License: mit
- Created: 2021-10-18T14:34:37.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-01-12T10:02:50.000Z (over 1 year ago)
- Last Synced: 2025-02-16T09:43:55.758Z (over 1 year ago)
- Topics: annotations, continuous-integration, github-actions, linting, problem-matcher, tests
- Language: Python
- Homepage:
- Size: 245 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 47
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 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/