Git Product home page Git Product logo

picfit-go's Introduction

picfit-go

Build Status

A Go client library for generating URLs with picfit

Installation

$ go get github.com/ulule/picfit-go

Usage

First, import the package:

import "github.com/ulule/picfit-go"

Now, you can access the package through picfit namespace.

API

GenerateThumbnailURL()

The GenerateThumbnailURL() function returns a pre-formatted URL for picfit server.

This function takes three required parameters:

  • path - your original image path
  • geometry - width and height formatted like this: widthxheight (example: "20x30")
  • options - picfit options

Supported options are:

  • Op - see Operations (defaults to thumbnail)
  • Crop - either crop image or not (true or false, defaults to false)
  • Upscale - see General Parameters (defaults to 0)
  • DefaultMethod - see Methods (defaults to display)
  • SecretKey - your secret key (see Security)

Options is just an instance of Options struct:

// Create your own instance, with your own parameters.
options := &picfit.Options{
	Op:            "thumbnail",
	Crop:          false,
	Upscale:       0,
	BaseURL:       "https://img.yourpicfitserver.com",
	DefaultMethod: "display",
	SecretKey:     "$ecretkeyplizkeepitseeeecret"
}

// Or, use the default ones (same as above) with NewOptions()
options := picfit.NewOptions()

// And, of course, you can override everything...
options.BaseURL = "https://img.superserver.com"
options.SecretKey = "qwerty1234ohitsbad"
options.Crop = true

Then, generate your URL:

url, err := picfit.GenerateThumbnailURL("image.jpg", "90x90", options)
if err != nil {
	fmt.Println("Oops, sorry guys")
}

Contributing

picfit-go's People

Contributors

gillesfabio avatar thoas avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.