tinypng

KO | EN

gitlite — search

#javascript #python #machine-learning #react #hacktoberfest #java #home-assistant #mysql #php #typescript #data-science #cpp

★ 72 Open GitHub ↗

Simple API client for TinyPNG.org.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# TinyPNG

TinyPNG is a simple API client for TinyPNG.org, which compresses your PNG images by 50-70% while preserving full transparency.

This gem was initially created by reverse engineering the [TinyPNG](http://tinypng.org/) website. Since then, TinyPNG has begun developing an [Official API](https://gist.github.com/savage69kr/6ecd0c98f8de7882b4f6) which is in alpha stages. In the future, an API key will be required to use the TinyPNG API and gem.

## Installation

Add this line to your application's Gemfile:

gem 'tinypng'

And then execute:

$ bundle

Or install it yourself as:

$ gem install tinypng

## Usage

Configure the TinyPNG client with your API key. You can set the `TINY_PNG_KEY` environment variable (helpful for [production configuration](http://12factor.net/config) or command-line usage) or specify the API key when creating each instance of `TinyPNG::Client`. Setting the key on instance initialization will override the global environment variable.

Use the Ruby API in your programs:

require 'tinypng'
    image_file = File.open(image_file_name)
    client = TinyPNG::Client.new('YOUR_TINY_PNG_API_KEY')
	image = client.shrink(image_file.read)
	image.input # => {"size"=>1234}
	image.output # => {"depth"=>8, "size"=>567, "ratio"=>0.459, "url"=>"http://tinypng.org/api/shrink/out/example.png"}
	image.to_file # => #<File:/tmp/tinypng20120910-5552-aturxh.png>

Or use the command line to shrink your images:

TINY_PNG_KEY=YOUR_TINY_PNG_API_KEY tinypng mybigimage.png myshrunkenimage.png

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

tinypng

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README