colourlovers 0.1.7

A python wrapper for ColourLovers API

Colourlovers-API-wrapper

Python wrapper for the API provided by www.colourlovers.com

Requirements

• Python 3 (Check elbaschid’s wrapper if using Python 2)

• PIL or Pillow

How to use it

Import the wrapper

1. First clone the repository by typing in a terminal: git clone https://github.com/juangallostra/Colourlovers-API-wrapper.git

2. Start a Python terminal session in the directory where you cloned the repository

3. Import the wrapper by:

   >>> from colourlovers import clapi
   >>> cl = clapi.ColourLovers()

Queries

Once we have created the API wrapper object (cl in the present case) we are ready to query the API. Note that a query, even if it is for a single object, always returns a list. The ColourLovers API queries are structured in three levels:

1. Object of the query. The possible query objects are: Color/s, Pattern/s, Palette/s, Lover/s or stats. Note that most of the objects can be queried in plural or in singular. The wrapper offers a different method for each object, all of them being:

   >>> cl.search_palette()  # Query for a single palette
   >>> cl.search_pattern()  # Query for a single pattern
   >>> cl.search_color()  # Query for a single color
   >>> cl.search_lover()  # Query for a single user
   >>> cl.search_palettes()  # Query for multiple palettes
   >>> cl.search_patterns()  # Query for multiple patterns
   >>> cl.search_colors()  # Query for multiple colors
   >>> cl.search_lovers()  # Query for multiple users
   >>> cl.search_stats()  # Query for a single pattern

   Each of these methods only accepts keyword arguments. Optionally, a first boolean positional argument can be passed specifying whether the response of the query should be returned as raw data or as a Python object. By default the response of a query will be returned as a Python object. Hence, the general form of a query to the API is:

   >>> cl.search_patterns(True, kwargs)  # Response will be returned as raw data
   >>> cl.search_patterns(kwargs)  # Response will be returned as a Python object

   We will get back to this later.

2. Type of the query. These are general, non-object dependent types and are specified via the request keyword. However, not all the types are supported by all the objects. The possible query types for each type of object are:

   Object	Supported Types
   Palettes	new, top, random or None
   Patterns	new, top, random or None
   Colors	new, top, random or None
   Lovers	new, top, or None
   Palette	id or None
   Pattern	id or None
   Color	hexvalue or None
   Lover	username or None
   Stats	colors, palettes, patterns, lovers

   The random query type is exclusive. When using it, no other parameters can be specified. Some examples of valid queries are:

   >>> cl.search_patterns(request='new')
   >>> cl.search_colors(request='top')
   >>> cl.search_stats(request='patterns')
   >>> cl.search_palettes(request='random')
   >>> cl.search_pattern(id=1145)
   >>> cl.search_lover(username='whatever')
   >>> cl.search_color(hexvalue='C6C5AC')

3. Object specific query parameters. These depend on the object of the query and are also specified as keyword arguments. To see which are the parameters supported by each object follow the links to the official API page in the following table. Note the differences in the available parameters when querying for multiple objects or for a single object.

   Object	Supported Types
   Palette/s	Parameters
   Pattern/s	Parameters
   Color/s	Parameters
   Lover/s	Parameters
   Stats	Parameters

   Examples of valid queries are:

   >>> cl.search_palettes(request='top', keywords='river', numresults=15)
   >>> cl.search_lovers(request='new', orderCol='numVotes')

   Note that the parameters are case-sensitive and that some of them expect predefined values. This edge cases are all listed at the official API documentation.

Other possible sources for color palettes

1. https://www.colr.org/api.html - (https://www.colr.org/)

2. https://www.pictaculous.com/api/ - (https://www.pictaculous.com/)

3. It is also worth mentioning https://github.com/elbaschid/python-colourlovers

ColourLovers API wrapper CHANGELOG

Alpha version (unreleased)

Added

• #13 Issue and Pull Request templates

• #22 Documentation: Wrapper usage in README

• #22 Support search by id when searching for one palette or pattern

• #22 Support search by username one searching for one user (Lover)

• #22 Support search by hexvalue when searching for one color

Deleted

Changed

• #15 Reduce amount of duplicated code amongst data-holder classes

• #19 Change names of files and folders

Fixed

• #14 When making a query the type of raw-data is checked. In case it is not a boolean value an exception is raised

• #23 Fix data loss when creating Python container objects