Giter VIP home page Giter VIP logo

unsplashframework's Introduction

UnsplashFramework

๐Ÿ“ท Introduction

The idea behind this project is to make an easy-to-use, well tested and well documented client framework for Unsplash.

Currently in early development stage ๐Ÿผ

๐Ÿ›  Plan

  • List photos
  • Search photos
  • Search collections
  • Search user
  • List collections
  • Users

Requirement

  • iOS 14.5+
  • XCode 13.0+

โฌ‡๏ธ Installation

CocoaPods

Add the following to your Podfile:

pod 'UnsplashFramework', '~> 0.1'

Carthage

Add the following to your Cartfile:

github "camiletti/UnsplashFramework" ~> 0.1

๐ŸŽ› Use

import UnsplashFramework

Credentials

Before doing any request, the Unsplash client credentials should be set. If you haven't registered yet, you can do so here.

let credentials = UNCredentials(appID: "Your_AppID", secret: "Your_Secret"
let client = UNClient(with: credentials)

Listing photos

client.listPhotos(page: 1,
                  photosPerPage: 10,
                  sortingBy: .popular)
    { result in
        switch result {
        case .success(let photos):
            photos.forEach({ (photo) in
                print("Photo with ID: \(photo.id) from user: \(photo.user.username) main color: \(photo.hexColor)")
            })

        case .failure(let error):
            print("Error: \(error.reason)")
    }
}

Searching photos

client.searchPhotos(query: "Forest",
                    page: 1,
                    photosPerPage: 10,
                    collections: nil,
                    orientation: .landscape)
    { result in
        switch result {
        case .success(let searchResult):
        searchResult.photos.forEach { (photo) in
            print("Photo with ID: \(photo.id) from user: \(photo.user.username) main color: \(photo.hexColor)")
        }
        
        case .failure(let error):
            print("Error: \(error.reason)")
        }
    }

๐Ÿ“– Documentation

Full documentation here

๐Ÿฆ Contact

@camiletti_p

๐Ÿ“„ License

UnsplashFramework is under MIT license.

Copyright 2021 Pablo Camiletti

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is furnished
to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

unsplashframework's People

Contributors

camiletti 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.