Skip to content

0.1.0

Compare
Choose a tag to compare
@github-actions github-actions released this 03 Jul 15:43
· 83 commits to refs/heads/main since this release
437f855

Added

CLI to format GitHub links in a shorter format.

Installation

From PyPI

python3 -m pip install --upgrade linkotron

With pipx

pipx install linkotron

From source

git clone https://github.com/hugovk/linkotron
cd linkotron
python3 -m pip install .

Usage

Run linkotron or linky, they do the same thing.

$ linky --help
usage: linky [-h] [-V] [-m] [-r] input

linkotron: CLI to format GitHub links in a shorter format.

positional arguments:
  input                 Text containing GitHub links to shorten

options:
  -h, --help            show this help message and exit
  -V, --version         show program's version number and exit
  -m, --md, --markdown  Output Markdown
  -r, --rst, --restructuredtext
                        Output reStructuredText

Linkify an issue

$ linky https://github.com/python/peps/issues/1012
python/peps#1012

Linkify a pull request

$ linky https://github.com/python/peps/pull/2399
python/peps#2399

Linkify a commit

$ linky https://github.com/hugovk/cpython/commit/28b23555030d58fdb52b74a547cc621c49690de0
hugovk/cpython#28b2355

Linkify a comment

$ linky https://github.com/python/peps/pull/2399#issuecomment-1063409480
python/peps#2399 (comment)

Formatting

Markdown
$ linky --md https://github.com/python/peps/pull/2399
[python/peps#2399](https://github.com/python/peps/pull/2399)
reStructuredText
$ linky --rst https://github.com/python/peps/pull/2399
`python/peps#2399 <https://github.com/python/peps/pull/2399>`__