Skip to main content

Color Palette is a simple tool for generating color palettes. It returns a list of colors based on a given color input.

Project description

Color Palette Generator API

Color Palette is a simple tool for generating color palettes. It returns a list of colors based on a given color input.

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the Color Palette Generator API


Installation

pip install apiverve-colorpalettegenerator

Configuration

Before using the colorpalette API client, you have to setup your account and obtain your API Key.
You can get it by signing up at https://apiverve.com


Usage

The Color Palette Generator API documentation is found here: https://docs.apiverve.com/api/colorpalette.
You can find parameters, example responses, and status codes documented here.

Setup

# Import the client module
from apiverve_colorpalettegenerator.apiClient import ColorpaletteAPIClient

# Initialize the client with your APIVerve API key
api = ColorpaletteAPIClient("[YOUR_API_KEY]")

Perform Request

Using the API client, you can perform requests to the API.

Define Query
query = { "color": "FF5733",  "variation": "soft" }
Simple Request
# Make a request to the API
result = api.execute(query)

# Print the result
print(result)
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "source": "#FF5733",
    "hue": 11,
    "variation": "soft",
    "colorPalette": [
      {
        "hex": "#cc988f",
        "name": "Oriental Pink"
      },
      {
        "hex": "#805f59",
        "name": "Russett"
      },
      {
        "hex": "#e6d2cf",
        "name": "Dust Storm"
      },
      {
        "hex": "#bf6e60",
        "name": "Contessa"
      },
      {
        "hex": "#a2cc8f",
        "name": "Pine Glade"
      },
      {
        "hex": "#658059",
        "name": "Glade Green"
      },
      {
        "hex": "#d6e6cf",
        "name": "Willow Brook"
      },
      {
        "hex": "#7dbf60",
        "name": "Mantis"
      },
      {
        "hex": "#607b89",
        "name": "Lynch"
      },
      {
        "hex": "#597380",
        "name": "Cutty Sark"
      },
      {
        "hex": "#cfdee6",
        "name": "Botticelli"
      },
      {
        "hex": "#60a0bf",
        "name": "Fountain Blue"
      }
    ],
    "colorPaletteRaw": [
      "cc988f",
      "805f59",
      "e6d2cf",
      "bf6e60",
      "a2cc8f",
      "658059",
      "d6e6cf",
      "7dbf60",
      "607b89",
      "597380",
      "cfdee6",
      "60a0bf"
    ]
  },
  "code": 200
}

Customer Support

Need any assistance? Get in touch with Customer Support.


Updates

Stay up to date by following @apiverveHQ on Twitter.


Legal

All usage of the APIVerve website, API, and services is subject to the APIVerve Terms of Service and all legal documents and agreements.


License

Licensed under the The MIT License (MIT)

Copyright (©) 2024 APIVerve, and Evlar LLC

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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apiverve_colorpalettegenerator-1.1.5.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file apiverve_colorpalettegenerator-1.1.5.tar.gz.

File metadata

File hashes

Hashes for apiverve_colorpalettegenerator-1.1.5.tar.gz
Algorithm Hash digest
SHA256 a6d72157b968c7ea24fee766f41b1e23c9125a7e934ad1b86dd8fc2bdd3f98bb
MD5 862741a8be42ad74febcf9ae9f2d7add
BLAKE2b-256 9cf15766619fa5bc5fc40dd7994b9dc7c9f85e8fbc2f10e5763b66279c3d9a2c

See more details on using hashes here.

File details

Details for the file apiverve_colorpalettegenerator-1.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for apiverve_colorpalettegenerator-1.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 17de6d0b8c80bfc508e50efbddebd2140e9130e715e05516b25e116b21a65b6f
MD5 ffcd00ee15dd7ff5888145f5c5963a02
BLAKE2b-256 7bfadb10f209caf149b1312bf8af07592e8b79b0200950a0331639e5a7615155

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page