https://github.com/joouha/sixelcrop

Crop sixel images in sixel-space!
https://github.com/joouha/sixelcrop

sixel terminal-graphics

Last synced: about 1 year ago
JSON representation

Crop sixel images in sixel-space!

• Host: GitHub
• URL: https://github.com/joouha/sixelcrop
• Owner: joouha
• License: mit
• Created: 2022-10-31T16:54:57.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-01-18T10:16:48.000Z (over 1 year ago)
• Last Synced: 2025-03-17T22:54:44.481Z (about 1 year ago)
• Topics: sixel, terminal-graphics
• Language: Python
• Homepage:
• Size: 25.4 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          


# sixelcrop

[![PyPI - Version](https://img.shields.io/pypi/v/sixelcrop.svg)](https://pypi.org/project/sixelcrop)

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/sixelcrop.svg)](https://pypi.org/project/sixelcrop)

**Crop sixel images in sixel-space!**

sixelcrop is a Python library and command line tool to crop [sixel](https://en.wikipedia.org/wiki/Sixel) images

-----

## Installation

```console

pipx install sixelcrop

# OR

pip install sixelcrop

```

## Usage

### Command Line

```

usage: sixelcrop [--help] [-x int] [-y int] [-w int] [-h int] [--no-private-colors] Path

Crop a sixel image in sixel space

positional arguments:

  Path                  Path to sixel image file (use '-' to read data from standard input)

options:

  --help

  -x int, --left int    The offset of the left edge of the target region

  -y int, --top int     The offset of the top edge of the target region

  -w int, --width int   The width of the target region

  -h int, --height int  The height of the target region

  --no-private-colors   Do not use private colors for each graphic

```

Example:

```bash

curl https://www.python.org/static/img/python-logo@2x.png | img2sixel | sixelcrop -x 10 -y 15 -w 120 -h 125 -

```

### Python API

```python

import sys

from sixelcrop import sixelcrop

with open("snake.six") as f:

    data = f.read()

sys.stdout.write(sixelcrop(data, x=300, y=50, w=200, h=150))

```

## License

`sixelcrop` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.