linkotron

Name	linkotron JSON
Version	0.3.1 JSON
	download
home_page	None
Summary	CLI to format links
upload_time	2024-11-05 15:36:02
maintainer	None
docs_url	None
author	Hugo van Kemenade
requires_python	>=3.10
license	MIT
keywords	link markdown md restructuredtext rst
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage

            # linkotron

[![PyPI version](https://img.shields.io/pypi/v/linkotron.svg?logo=pypi&logoColor=FFE873)](https://pypi.org/project/linkotron/)
[![Supported Python versions](https://img.shields.io/pypi/pyversions/linkotron.svg?logo=python&logoColor=FFE873)](https://pypi.org/project/linkotron/)
[![PyPI downloads](https://img.shields.io/pypi/dm/linkotron.svg)](https://pypistats.org/packages/linkotron)
[![Test](https://github.com/hugovk/linkotron/actions/workflows/test.yml/badge.svg)](https://github.com/hugovk/linkotron/actions)
[![Codecov](https://codecov.io/gh/hugovk/linkotron/branch/main/graph/badge.svg)](https://codecov.io/gh/hugovk/linkotron)
[![Licence](https://img.shields.io/github/license/hugovk/linkotron.svg)](LICENSE.txt)
[![Code style: Black](https://img.shields.io/badge/code%20style-Black-000000.svg)](https://github.com/psf/black)

CLI to format GitHub links in a shorter format.

## Installation

### From PyPI

```bash
python3 -m pip install --upgrade linkotron
```

### With [pipx][pipx]

```bash
pipx install linkotron
```

[pipx]: https://github.com/pypa/pipx

### From source

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

## Usage

Run `linkotron` or `linky`, they do the same thing.

<!-- [[[cog
from linkotron.scripts.run_command import run
run("linky --help")
]]] -->

```console
$ linky --help
usage: linky [-h] [-V] [--no-copy] [-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
  --no-copy             do not copy output to clipboard

formatters:
  -m, --md, --markdown  output in Markdown
  -r, --rst, --restructuredtext
                        output in reStructuredText
```

<!-- [[[end]]] -->

### Linkify a repo

<!-- [[[cog
run("linky https://github.com/python/peps")
]]] -->

```console
$ linky https://github.com/python/peps
Copied! python/peps
```

<!-- [[[end]]] -->

### Linkify an issue

<!-- [[[cog
run("linky https://github.com/python/peps/issues/1012")
]]] -->

```console
$ linky https://github.com/python/peps/issues/1012
Copied! python/peps#1012
```

<!-- [[[end]]] -->

### Linkify a pull request

<!-- [[[cog
run("linky https://github.com/python/peps/pull/2399")
]]] -->

```console
$ linky https://github.com/python/peps/pull/2399
Copied! python/peps#2399
```

<!-- [[[end]]] -->

### Linkify a commit

<!-- [[[cog
run("linky https://github.com/hugovk/cpython/commit/28b23555030d58fdb52b74a547cc621c49690de0")
]]] -->

```console
$ linky https://github.com/hugovk/cpython/commit/28b23555030d58fdb52b74a547cc621c49690de0
Copied! hugovk/cpython#28b2355
```

<!-- [[[end]]] -->

### Linkify a comment

<!-- [[[cog
run("linky https://github.com/python/peps/pull/2399#issuecomment-1063409480")
]]] -->

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

<!-- [[[end]]] -->

### Formatting

#### Markdown

<!-- [[[cog
run("linky --md https://github.com/python/peps/pull/2399")
]]] -->

```console
$ linky --md https://github.com/python/peps/pull/2399
Copied! [python/peps#2399](https://github.com/python/peps/pull/2399)
```

<!-- [[[end]]] -->

#### reStructuredText

<!-- [[[cog
run("linky --rst https://github.com/python/peps/pull/2399")
]]] -->

```console
$ linky --rst https://github.com/python/peps/pull/2399
Copied! `python/peps#2399 <https://github.com/python/peps/pull/2399>`__
```

<!-- [[[end]]] -->

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "linkotron",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "link, markdown, md, restructuredtext, rst",
    "author": "Hugo van Kemenade",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/96/c3/cc1145bccad7eb92a9510cca0521bbec058a6c0f07140f7edffecc11487d/linkotron-0.3.1.tar.gz",
    "platform": null,
    "description": "# linkotron\n\n[![PyPI version](https://img.shields.io/pypi/v/linkotron.svg?logo=pypi&logoColor=FFE873)](https://pypi.org/project/linkotron/)\n[![Supported Python versions](https://img.shields.io/pypi/pyversions/linkotron.svg?logo=python&logoColor=FFE873)](https://pypi.org/project/linkotron/)\n[![PyPI downloads](https://img.shields.io/pypi/dm/linkotron.svg)](https://pypistats.org/packages/linkotron)\n[![Test](https://github.com/hugovk/linkotron/actions/workflows/test.yml/badge.svg)](https://github.com/hugovk/linkotron/actions)\n[![Codecov](https://codecov.io/gh/hugovk/linkotron/branch/main/graph/badge.svg)](https://codecov.io/gh/hugovk/linkotron)\n[![Licence](https://img.shields.io/github/license/hugovk/linkotron.svg)](LICENSE.txt)\n[![Code style: Black](https://img.shields.io/badge/code%20style-Black-000000.svg)](https://github.com/psf/black)\n\nCLI to format GitHub links in a shorter format.\n\n## Installation\n\n### From PyPI\n\n```bash\npython3 -m pip install --upgrade linkotron\n```\n\n### With [pipx][pipx]\n\n```bash\npipx install linkotron\n```\n\n[pipx]: https://github.com/pypa/pipx\n\n### From source\n\n```bash\ngit clone https://github.com/hugovk/linkotron\ncd linkotron\npython3 -m pip install .\n```\n\n## Usage\n\nRun `linkotron` or `linky`, they do the same thing.\n\n<!-- [[[cog\nfrom linkotron.scripts.run_command import run\nrun(\"linky --help\")\n]]] -->\n\n```console\n$ linky --help\nusage: linky [-h] [-V] [--no-copy] [-m | -r] input\n\nlinkotron: CLI to format GitHub links in a shorter format.\n\npositional arguments:\n  input                 text containing GitHub links to shorten\n\noptions:\n  -h, --help            show this help message and exit\n  -V, --version         show program's version number and exit\n  --no-copy             do not copy output to clipboard\n\nformatters:\n  -m, --md, --markdown  output in Markdown\n  -r, --rst, --restructuredtext\n                        output in reStructuredText\n```\n\n<!-- [[[end]]] -->\n\n### Linkify a repo\n\n<!-- [[[cog\nrun(\"linky https://github.com/python/peps\")\n]]] -->\n\n```console\n$ linky https://github.com/python/peps\nCopied! python/peps\n```\n\n<!-- [[[end]]] -->\n\n### Linkify an issue\n\n<!-- [[[cog\nrun(\"linky https://github.com/python/peps/issues/1012\")\n]]] -->\n\n```console\n$ linky https://github.com/python/peps/issues/1012\nCopied! python/peps#1012\n```\n\n<!-- [[[end]]] -->\n\n### Linkify a pull request\n\n<!-- [[[cog\nrun(\"linky https://github.com/python/peps/pull/2399\")\n]]] -->\n\n```console\n$ linky https://github.com/python/peps/pull/2399\nCopied! python/peps#2399\n```\n\n<!-- [[[end]]] -->\n\n### Linkify a commit\n\n<!-- [[[cog\nrun(\"linky https://github.com/hugovk/cpython/commit/28b23555030d58fdb52b74a547cc621c49690de0\")\n]]] -->\n\n```console\n$ linky https://github.com/hugovk/cpython/commit/28b23555030d58fdb52b74a547cc621c49690de0\nCopied! hugovk/cpython#28b2355\n```\n\n<!-- [[[end]]] -->\n\n### Linkify a comment\n\n<!-- [[[cog\nrun(\"linky https://github.com/python/peps/pull/2399#issuecomment-1063409480\")\n]]] -->\n\n```console\n$ linky https://github.com/python/peps/pull/2399#issuecomment-1063409480\nCopied! python/peps#2399 (comment)\n```\n\n<!-- [[[end]]] -->\n\n### Formatting\n\n#### Markdown\n\n<!-- [[[cog\nrun(\"linky --md https://github.com/python/peps/pull/2399\")\n]]] -->\n\n```console\n$ linky --md https://github.com/python/peps/pull/2399\nCopied! [python/peps#2399](https://github.com/python/peps/pull/2399)\n```\n\n<!-- [[[end]]] -->\n\n#### reStructuredText\n\n<!-- [[[cog\nrun(\"linky --rst https://github.com/python/peps/pull/2399\")\n]]] -->\n\n```console\n$ linky --rst https://github.com/python/peps/pull/2399\nCopied! `python/peps#2399 <https://github.com/python/peps/pull/2399>`__\n```\n\n<!-- [[[end]]] -->\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "CLI to format links",
    "version": "0.3.1",
    "project_urls": {
        "Changelog": "https://github.com/hugovk/linkotron/releases",
        "Homepage": "https://github.com/hugovk/linkotron",
        "Source": "https://github.com/hugovk/linkotron"
    },
    "split_keywords": [
        "link",
        " markdown",
        " md",
        " restructuredtext",
        " rst"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c939088be3a6f24946ebf8452e420f083883c10b686cc6a0638d8704193aff6e",
                "md5": "e8ae90afffcf3e6a0e75e7bbbb51b991",
                "sha256": "18ae361baed54af38ca837f04b707ddb5aba0f70318f869aa834d0d1b48388c5"
            },
            "downloads": -1,
            "filename": "linkotron-0.3.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e8ae90afffcf3e6a0e75e7bbbb51b991",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 6453,
            "upload_time": "2024-11-05T15:36:00",
            "upload_time_iso_8601": "2024-11-05T15:36:00.352506Z",
            "url": "https://files.pythonhosted.org/packages/c9/39/088be3a6f24946ebf8452e420f083883c10b686cc6a0638d8704193aff6e/linkotron-0.3.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "96c3cc1145bccad7eb92a9510cca0521bbec058a6c0f07140f7edffecc11487d",
                "md5": "6b68e05f0aed7dbd2df60896faf1b5b8",
                "sha256": "30e76057bad631276db0dc4cff3e606083e70119c1eb5f4b20be59c694a7b85c"
            },
            "downloads": -1,
            "filename": "linkotron-0.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "6b68e05f0aed7dbd2df60896faf1b5b8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 10674,
            "upload_time": "2024-11-05T15:36:02",
            "upload_time_iso_8601": "2024-11-05T15:36:02.205524Z",
            "url": "https://files.pythonhosted.org/packages/96/c3/cc1145bccad7eb92a9510cca0521bbec058a6c0f07140f7edffecc11487d/linkotron-0.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-05 15:36:02",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "hugovk",
    "github_project": "linkotron",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "tox": true,
    "lcname": "linkotron"
}