https://github.com/sirius248/flickr_collage_tty

Collage generator with Flickr
https://github.com/sirius248/flickr_collage_tty

ruby

Last synced: 8 months ago
JSON representation

Collage generator with Flickr

• Host: GitHub
• URL: https://github.com/sirius248/flickr_collage_tty
• Owner: sirius248
• License: mit
• Created: 2017-07-21T15:23:02.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2017-07-23T17:37:39.000Z (almost 9 years ago)
• Last Synced: 2025-03-05T02:45:30.250Z (over 1 year ago)
• Topics: ruby
• Language: Ruby
• Homepage: https://github.com/kimquy/flickr_collage_tty
• Size: 26.4 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# FlickrCollageTty

[![Code Climate](https://codeclimate.com/github/kimquy/flickr_collage_tty/badges/gpa.svg)](https://codeclimate.com/github/kimquy/flickr_collage_tty)

[![Build Status](https://travis-ci.org/kimquy/flickr_collage_tty.svg?branch=master)](https://travis-ci.org/kimquy/flickr_collage_tty)

FlickrCollageTty allow you to create a collage from keywords you enter into the terminal. Then it will fetch the most suitable image from Flickr correspond to each keyword.

![screenshot](https://user-images.githubusercontent.com/2282642/28498501-2c64cce4-6fc9-11e7-889a-1d4dbe1069f3.jpg)

## Installation

    $ gem install flickr_collage_tty

## Requirements

In order to this gem to work the following things are required:

* ImageMagick

* Flickr API key

## Program design

![design](https://user-images.githubusercontent.com/2282642/28501264-815d205a-7002-11e7-9995-9e3095eb100f.png)

## Usage

```ruby

# Simply run the following command into the terminal

# Then follow the instruction of the programm

# The program will ask for the Flickr API credentials

# for the first time. If it successful authenticate, then

# the program will not ask for the credentials again.

fc_tty

```

## Improvements

* Improve test coverages, more meaningful test cases.

* Improve test speed (VCR, or can do simple stub/mock)

* Improve the download images speed. May allow to download multiple images concurrently.

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/kimquy/flickr_collage_tty. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).