README.md

anishot

Animates a long screenshot into a GIF. Use it to show off long screenshots in your GitHub README.

Install

$ pip install anishot

Usage

$ anishot --help
usage: anishot [-h] [--pad PAD] [--maxspeed MAXSPEED] [--stops [STOPS [STOPS ...]]]
               [--zoom-steps ZOOM_STEPS] [--start-scale START_SCALE]
               [--zoom-to ZOOM_TO] [--shadow-size SHADOW_SIZE]
               [--rgb-outline RGB_OUTLINE] [--rgb-background RGB_BACKGROUND]
               [--rgb-shadow RGB_SHADOW] [--rgb-window RGB_WINDOW]
               input output height

Animates a long screenshot into a GIF

positional arguments:
  input                 Input screenshot image
  output                Output animated GIF
  height                Window height

optional arguments:
  -h, --help            show this help message and exit
  --pad PAD     Padding on sides
  --maxspeed MAXSPEED
                        Max speed on scroll px/frame
  --stops [STOPS [STOPS ...]]
                        Stops between scrolls, px
  --zoom-steps ZOOM_STEPS
                        Number of steps on initial zoom in
  --start-scale START_SCALE
                        Start scale
  --zoom-to ZOOM_TO     Point to zoom to
  --shadow-size SHADOW_SIZE
                        Shadow size
  --rgb-outline RGB_OUTLINE
                        Screenshot outline color
  --rgb-background RGB_BACKGROUND
                        Background color
  --rgb-shadow RGB_SHADOW
                        Screenshot shadow color
  --rgb-window RGB_WINDOW
                        Window outline color

The anishot at the top of this README was generated by: anishot --stops 290 640 940 --zoom-to 150 --start-scale .7 anishot.png anishot.gif 450

You can also experiment with styles. For example, you can go for a retro look:

anishot --stops 290 640 940 --zoom-to 150 --start-scale .7 --pad 50 --shadow-size 5 --rgb-bg #cccccc --rgb-window #666666 anishot.png anishot.gif 450

Contributing

Contributions are welcome!