https://github.com/ctolkien/tinypng
.NET Standard wrapper around the tinypng.com image compression service
https://github.com/ctolkien/tinypng
amazon-s3-storage compress-images compressing-images compression csharp-library dotnet-core hacktoberfest tinypng
Last synced: 11 months ago
JSON representation
.NET Standard wrapper around the tinypng.com image compression service
- Host: GitHub
- URL: https://github.com/ctolkien/tinypng
- Owner: ctolkien
- License: mit
- Created: 2015-11-24T03:07:39.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2024-08-27T12:43:58.000Z (over 1 year ago)
- Last Synced: 2025-04-06T08:14:29.407Z (11 months ago)
- Topics: amazon-s3-storage, compress-images, compressing-images, compression, csharp-library, dotnet-core, hacktoberfest, tinypng
- Language: C#
- Homepage:
- Size: 419 KB
- Stars: 64
- Watchers: 5
- Forks: 18
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# TinyPng for .NET
[](https://www.nuget.org/packages/TinyPNG)
[](LICENSE)
This is a .NET Standard wrapper around the [TinyPNG.com](https://tinypng.com) image compression service. This is not an official TinyPNG.com product.
* Supports .NET Core and full .NET Framework
* Non-blocking async turtles all the way down
* `Byte[]`, `Stream`, `File` and `Url` API's available
## Installation
Install via Nuget
```
Install-Package TinyPNG
```
Install via `dotnet`
```
dotnet add package TinyPNG
```
## Quickstart
```csharp
using var png = new TinyPngClient("yourSecretApiKey");
var result = await png.Compress("cat.jpg");
//URL to your compressed version
result.Output.Url;
```
# Version Upgrades
## Upgrading from V3 to V4
* The namespaces have changed for the extension methods to all reside in the `TinyPng` namespace. This will avoid needing to bring in two different namespaces.
* The `CompressFromUrl` method has been removed. This is now available via a new overload for `Compress` which takes in a `Uri` object
* I've standardised the namespace on `TinyPng`, it was a bit of a mixed bag of casing previously.
## Upgrading from V2 to V3
The API has changed from V2, primarily you no longer need to await each individual
step of using the TinyPNG API, you can now chain appropriate calls together as
the extension methods now operate on `Task`.
## Compressing Images
```csharp
// create an instance of the TinyPngClient
using var png = new TinyPngClient("yourSecretApiKey");
// Create a task to compress an image.
// this gives you the information about your image as stored by TinyPNG
// they don't give you the actual bits (as you may want to chain this with a resize
// operation without caring for the originally sized image).
var compressImageTask = png.Compress("pathToFile or byte array or stream");
// or `CompressFromUrl` if compressing from a remotely hosted image.
var compressFromUrlImageTask = png.CompressFromUrl("image url");
// If you want to actually save this compressed image off
// it will need to be downloaded
var compressedImage = await compressImageTask.Download();
// you can then get the bytes
var bytes = await compressedImage.GetImageByteData();
// get a stream instead
var stream = await compressedImage.GetImageStreamData();
// or just save to disk
await compressedImage.SaveImageToDisk("pathToSaveImage");
// Putting it all together
await png.Compress("path")
.Download()
.SaveImageToDisk("savedPath");
```
Further details about the result of the compression are also available on the `Input` and `Output` properties of a `Compress` operation. Some examples:
```csharp
var result = await png.Compress("pathToFile or byte array or stream");
// old size
result.Input.Size;
// new size
result.Output.Size;
// URL of the compressed Image
result.Output.Url;
```
## Resizing Images
```csharp
using var png = new TinyPngClient("yourSecretApiKey");
var compressImageTask = png.Compress("pathToFile or byte array or stream");
var resizedImageTask = compressImageTask.Resize(width, height);
await resizedImageTask.SaveImageToDisk("pathToSaveImage");
// altogether now....
await png.Compress("pathToFile")
.Resize(width, height)
.SaveImageToDisk("pathToSaveImage");
```
### Resize Operations
There are certain combinations when specifying resize options which aren't compatible with
TinyPNG. We also include strongly typed resize operations,
depending on the type of resize you want to do.
```csharp
using var png = new TinyPngClient("yourSecretApiKey");
var compressTask = png.Compress("pathToFile or byte array or stream");
await compressTask.Resize(new ScaleWidthResizeOperation(width));
await compressTask.Resize(new ScaleHeightResizeOperation(height));
await compressTask.Resize(new FitResizeOperation(width, height));
await compressTask.Resize(new CoverResizeOperation(width, height));
```
The same `Byte[]`, `Stream`, `File` and `Url` path API's are available from the result of the `Resize()` method.
## Converting Formats (v4)
You can convert images to different formats using the `Convert()` method. This will return a object which contains the converted image data.
```csharp
using var png = new TinyPngClient("yourSecretApiKey");
var compressAndConvert = await png.Compress("cat.png").Convert(ConvertImageFormat.Wildcard);
```
By using the `Wildcard` format, TinyPng will return the best type for the supplied image.
In the scenario that you are converting to an image and losing transparency, you can specify a background colour to use for the image.
```csharp
var compressAndConvert = await png.Compress("cat.png").Convert(ConvertImageFormat.Wildcard, "#FF0000");
```
## Amazon S3 Storage
The result of any compress operation can be stored directly on to Amazon S3 storage. I'd strongly recommend referring to [TinyPNG.com's documentation](https://tinypng.com/developers/reference) with regard to how to configure
the appropriate S3 access.
If you're going to be storing images for most requests into S3, then you can pass in an `AmazonS3Configuration` object to the constructor which will be used for all subsequent requests.
```csharp
using var png = new TinyPngClient("yourSecretApiKey",
new AmazonS3Configuration("awsAccessKeyId", "awsSecretAccessKey", "bucket", "region"));
var compressedCat = await png.Compress("cat.jpg");
var s3Uri = await png.SaveCompressedImageToAmazonS3(compressedCat, "file-name.png");
// If you'd like to override the particular bucket or region
// an image is being stored to from what is specified in the AmazonS3Configuration:
var s3UriInNewSpot = await png.SaveCompressedImageToAmazonS3(
compressedCat,
"file-name.png",
bucketOverride: "different-bucket",
regionOverride: "different-region");
```
You can also pass a `AmazonS3Configuration` object directly into calls to `SaveCompressedImageToAmazonS3`
```csharp
using var png = new TinyPngClient("yourSecretApiKey");
var compressedCat = await png.Compress("cat.jpg");
var s3Uri = await png.SaveCompressedImageToAmazonS3(compressedCat,
new AmazonS3Configuration(
"awsAccessKeyId",
"awsSecretAccessKey",
"bucket",
"region"), "file-name.png");
```
## Compression Count
You can get a read on the number of compression operations you've performed by inspecting the `CompressionCount` property
on the result of any operation you've performed. This is useful for keeping tabs on your API usage.
```csharp
var compressedCat = await png.Compress("cat.jpg");
compressedCat.CompressionCount; // = 5
```
## HttpClient
TinyPngClient can take HttpClient as constructor overload, the lifetime of which can be controlled from outside the library.
```csharp
var httpClient = new HttpClient();
var png = new TinyPngClient("yourSecretApiKey", httpClient);
```