juangallostra / colourlovers-api-wrapper Goto Github PK

cl = clapi.ColourLovers()
pattern = cl.search_patterns(request='random')[0]

Current behavior

KeyError: 'request'

Expected behavior

'new' and 'top' return correct result

Screenshot (optional)

Current behavior

The README does not list the extra methods (such as draw) available in some of the container objects obtained after a request.

Expected behavior

This methods are listed and demonstrated in the README.

Steps to reproduce

Setup:

python3 -m venv .env
.env/bin/pip install --upgrade pip
.env/bin/pip install colourlovers

Then run .env/bin/python script.py with

from colourlovers import clapi
cl = clapi.ColourLovers()

for type in ['new', 'top', 'random']:
    print(type)
    print(cl.search_palettes(request=type, numResults=1))

Current behavior

This prints

new
[<colourlovers.data_containers.Palette object at 0x7f33644cad60>]
top
[<colourlovers.data_containers.Palette object at 0x7f3362fcec10>]
random
Traceback (most recent call last):
  File "./script.py", line 8, in <module>
    print(cl.search_palettes(request=type, numResults=1))
  File "./.env/lib/python3.8/site-packages/colourlovers/clapi.py", line 237, in _api_search
    processed_request = self.__process_optional_requests(search_type, **kwargs)
  File "./.env/lib/python3.8/site-packages/colourlovers/clapi.py", line 402, in __process_optional_requests
    del kwargs[valid_keyword]
KeyError: 'request'

So, new and top searches work, but random fails.

Expected behavior

cl.search_palettes(request="random", numResults=1) should return a list containing one random Palette object.

Show in the readme some usage examples of how the API is used

Current behavior

It is hard to import the API wrapper. Currently, to import the wrapper one has to:

from colourlovers_api import wrapper
cl = wrapper.ColourLovers()

Expected behavior

The API wrapper can be easily imported and with names that make sense.

Screenshot (optional)

When searching by pattern or palette the API accepts as a valid parameter a patternID or paletteID respectively. The wrapper doesn't currently support specifying IDs for pattern and palette searches. The same goes with lover and the parameter username and color and the parameter hexvalue