Metadata-Version: 2.4
Name: qrcat
Version: 1.0.1
Summary: Render QR codes directly to the terminal using just block chars.
Project-URL: Homepage, https://github.com/MarcinOrlowski/qrcat
Project-URL: Repository, https://github.com/MarcinOrlowski/qrcat
Project-URL: Issues, https://github.com/MarcinOrlowski/qrcat/issues
Author-email: Marcin Orlowski <mail@MarcinOrlowski.com>
License: MIT
Keywords: console,qrc,qrcode,terminal
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Text Processing
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Requires-Dist: segno>=1.6
Provides-Extra: dev
Requires-Dist: black>=23.0; extra == 'dev'
Requires-Dist: build; extra == 'dev'
Requires-Dist: faker; extra == 'dev'
Requires-Dist: flake8; extra == 'dev'
Requires-Dist: flake8-docstrings; extra == 'dev'
Requires-Dist: flake8-noqa; extra == 'dev'
Requires-Dist: mypy>=1.0; extra == 'dev'
Requires-Dist: pytest-cov>=4.0; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: python-dateutil; extra == 'dev'
Requires-Dist: ruff>=0.1.0; extra == 'dev'
Requires-Dist: twine; extra == 'dev'
Requires-Dist: types-markdown; extra == 'dev'
Requires-Dist: types-pyyaml; extra == 'dev'
Requires-Dist: wemake-python-styleguide; extra == 'dev'
Requires-Dist: wheel; extra == 'dev'
Description-Content-Type: text/markdown

![qrcat logo](docs/logo.webp)


![PyPI - Version](https://img.shields.io/pypi/v/qrcat?style=flat)
[![PyPI Downloads](https://static.pepy.tech/badge/qrcat)](https://pepy.tech/projects/qrcat)
![MIT License](https://img.shields.io/github/license/MarcinOrlowski/qrcat)

# qrcat

`qrcat` (pronounced `Purr Cat`) is a command line utility that prints QR codes directly to your
terminal using nothing but block characters.

```bash
pipx install qrcat
```

Aside from being a standalone application, you can also use `qrcat` in your Python project.
See [dev docs](docs/README.md) for more information.

## Features

- Pure-Python, single runtime dep (`segno`) — no Pillow, no browser, no PNG.
- Pluggable renderer architecture — half-block today, quadrant / ANSI-color drop-in tomorrow.
- Works in any unicode-capable terminal.
- Library for your Python project *and* CLI tool from the same package.

## Example

```bash
$ qrcat https://MarcinOrlowski.com

█▀▀▀▀▀█  ██▀ █▄▄▀ █▀▀▀▀▀█
█ ███ █ █▄▄ █▄█▀▀ █ ███ █
█ ▀▀▀ █ █▄▀█▄▄█▄▀ █ ▀▀▀ █
▀▀▀▀▀▀▀ █▄█▄█ █ ▀ ▀▀▀▀▀▀▀
▀▄██▀▀▀▄▄▀█ █▀█▀█ ▀█▀▀▀▄
█▄▀█ █▀▀▀  █ ▀▄▀█▄██▄▀ ▀█
▄▄ ▀▄█▀▀█▄▀▀██▀▄▄█▀▄ ▄▀█▀
█  █ ▄▀  █▀  ▀▄▀▄ ▀██▀ ▀█
▀ ▀▀  ▀▀██ █▀█▀▄█▀▀▀█▄▀
█▀▀▀▀▀█ ▄▄▀▄  ▄ █ ▀ █▄▀▀▀
█ ███ █ ██▀█▀█ ▀▀██▀█▄█▄▄
█ ▀▀▀ █ ▀▄█▄▄▀▀██ ▄▄▄█▀ █
▀▀▀▀▀▀▀ ▀▀  ▀▀▀  ▀ ▀▀▀▀▀▀
```

## Easy installation

Use [pipx](https://pypi.org/project/pipx/) package manager to install `qrcat` as standalone
application.

```bash
pipx install qrcat
```

Once installed `qrcat` binary should be instantly available in your terminal.

## License

* Written and copyrighted &copy;2026 by Marcin Orlowski <mail (#) marcinorlowski (.) com>
* `qrcat` is open-source software licensed under
  the [MIT license](http://opensource.org/licenses/MIT)
