Skip to main content

CLI to format links

Project description

linkotron

PyPI version Supported Python versions PyPI downloads Test Codecov Licence Code style: Black

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>`__

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

linkotron-0.1.1.tar.gz (9.7 kB view hashes)

Uploaded Source

Built Distribution

linkotron-0.1.1-py3-none-any.whl (5.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page