Amazing-QR

https://github.com/x-hw/amazing-qr
Admin
Amazing-QR is a Python QR code generator for creating standard, artistic, and animated GIF QR codes...
Tokens:9,684
Snippets:63
Trust Score:8.3
License:GPL-3.0
Update:4 weeks ago
Show doc for...
Tokens:
Raw
### Install amzqr via pip

Source: https://github.com/x-hw/amazing-qr/blob/master/README.md

Install the amzqr package using pip. This is the primary installation method for using the library or CLI.

```python
pip install amzqr
```

--------------------------------

### Install agent skill for generate-amazing-qr-code

Source: https://github.com/x-hw/amazing-qr/blob/master/README.md

Install the 'generate-amazing-qr-code' skill from the x-hw/skills repository using npx. This skill teaches AI agents to generate QR codes with the amzqr CLI.

```sh
npx skills add x-hw/skills --skill generate-amazing-qr-code
```

--------------------------------

### Source file notice template

Source: https://github.com/x-hw/amazing-qr/blob/master/LICENSE.md

Template to attach to the start of each source file, including program name, copyright line, and warranty disclaimer.

```plaintext
        <one line to give the program's name and a brief idea of what it does.>
        Copyright (C) <year>  <name of author>
    
        This program is free software: you can redistribute it and/or modify
        it under the terms of the GNU General Public License as published by
        the Free Software Foundation, either version 3 of the License, or
        (at your option) any later version.
    
        This program is distributed in the hope that it will be useful,
        but WITHOUT ANY WARRANTY; without even the implied warranty of
        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
        GNU General Public License for more details.
    
        You should have received a copy of the GNU General Public License
        along with this program.  If not, see <http://www.gnu.org/licenses/>.
```

--------------------------------

### Interactive mode notice template

Source: https://github.com/x-hw/amazing-qr/blob/master/LICENSE.md

Short notice to output when the program starts in interactive mode, including warranty and redistribution information.

```plaintext
        <program>  Copyright (C) <year>  <name of author>
        This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
        This is free software, and you are welcome to redistribute it
        under certain conditions; type `show c' for details.
```

--------------------------------

### Python library usage for amzqr.run

Source: https://github.com/x-hw/amazing-qr/blob/master/README.md

Shows how to call the amzqr.run function from the amzqr library with all parameters. Returns version, level, and the generated QR code filename. Parameters include words, version, level, picture, colorized, contrast, brightness, save_name, and save_dir.

```python
from amzqr import amzqr

version, level, qr_name = amzqr.run(
    words,
    version=1,
    level="H",
    picture=None,
    colorized=False,
    contrast=1.0,
    brightness=1.0,
    save_name=None,
    save_dir=os.getcwd(),
)
```

--------------------------------

### Customize output filename and directory with -n and -d

Source: https://github.com/x-hw/amazing-qr/blob/master/README.md

Specifies the output filename and directory. The default filename is 'qrcode.png' and default directory is the current directory. The filename can end with .jpg, .png, .bmp, or .gif. If the file already exists, it will be overwritten.

```markdown
#3 -n, -d
amzqr https://github.com   -n github_qr.jpg   -d .../paths/
```

--------------------------------

### CLI usage summary for amzqr

Source: https://github.com/x-hw/amazing-qr/blob/master/README.md

Shows the full command-line syntax for the amzqr command, including all available options: -v for version, -l for error correction level, -n for output filename, -d for output directory, -p for picture file, -c for colorized, -con for contrast, -bri for brightness, and -V for version. Use this as a reference for all CLI invocations.

```sh
# summary
amzqr Words
      [-v {1,2,3,...,40}]
      [-l {L,M,Q,H}]
      [-n output-filename]
      [-d output-directory]
      [-p picture_file]
      [-c]
      [-con contrast]
      [-bri brightness]
      [-V]
```

--------------------------------

### amzqr.run parameter reference

Source: https://github.com/x-hw/amazing-qr/blob/master/README.md

Lists the positional and optional parameters for amzqr.run: words (str), version (int 1-40), level (one of 'L','M','Q','H'), picture (filename), colorized (bool), contrast (float), brightness (float), save_name (output filename like 'example.png'), and save_dir (output directory).

```python
# help(amzqr)
Positional parameter
   words: str

Optional parameters
   version: int, from 1 to 40
   level: str, just one of ('L','M','Q','H')
   picture: str, a filename of a image
   colorized: bool
   contrast: float
   brightness: float
   save_name: str, the output filename like 'example.png'
   save_dir: str, the output directory
```

--------------------------------

### Basic QR code generation with amzqr

Source: https://github.com/x-hw/amazing-qr/blob/master/README.md

Generates a QR code from a URL or sentence with default settings, producing 'qrcode.png' in the current directory. The default error correction level is H (highest).

```markdown
#1 Words
amzqr https://github.com
```

--------------------------------

### Adjust contrast and brightness with -con and -bri

Source: https://github.com/x-hw/amazing-qr/blob/master/README.md

Changes the contrast and brightness of the resulting picture. -con and -bri accept float values; default is 1.0 for both. Low values mean low contrast/brightness, high values mean high contrast/brightness.

```markdown
#3 -con, -bri
amzqr https://github.com -p github.jpg [-c] -con 1.5 -bri 1.6
```

--------------------------------

### Artistic QR code with picture (-p)

Source: https://github.com/x-hw/amazing-qr/blob/master/README.md

Combines the QR code with a picture file (e.g., github.jpg) located in the same directory as the program. The resulting image is black and white by default.

```markdown
#1 -p
amzqr https://github.com -p github.jpg
```

--------------------------------

### Customize version and error correction with -v and -l

Source: https://github.com/x-hw/amazing-qr/blob/master/README.md

Sets the QR code version (size) from 1 to 40 and error correction level (L, M, Q, H) using -v and -l. The default version depends on input length and level; default level is H.

```markdown
#2 -v, -l
amzqr https://github.com -v 10 -l Q
```

--------------------------------

### Colorized artistic QR code (-c)

Source: https://github.com/x-hw/amazing-qr/blob/master/README.md

Adds the -c flag to make the resulting picture colorized instead of black and white.

```markdown
#2 -c
amzqr https://github.com -p github.jpg -c
```
Tokens:
Raw