Skip to main content

Text to Color is a simple tool for converting color from natural language. It returns the color code based on the text provided.

Project description

Text to Color API

Text to Color is a simple tool for converting color from natural language. It returns the color code based on the text provided.

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the Text to Color API


Installation

Using pip:

pip install apiverve-texttocolor

Using pip3:

pip3 install apiverve-texttocolor

Configuration

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


Quick Start

Here's a simple example to get you started quickly:

from apiverve_texttocolor.apiClient import TexttocolorAPIClient

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

query = { "color": "turquoise" }

try:
    # Make the API call
    result = api.execute(query)

    # Print the result
    print(result)
except Exception as e:
    print(f"Error: {e}")

Usage

The Text to Color API documentation is found here: https://docs.apiverve.com/ref/texttocolor. You can find parameters, example responses, and status codes documented here.

Setup

# Import the client module
from apiverve_texttocolor.apiClient import TexttocolorAPIClient

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

Perform Request

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

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

# Print the result
print(result)
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "color": "turquoise",
    "hex": "#66c8b8",
    "rgb": "102, 200, 184",
    "hsl": "170, 47, 59",
    "cmyk": "49, 0, 8, 22",
    "ansi16": 96,
    "channels": {
      "rgbChannels": 3,
      "cmykChannels": 4,
      "ansiChannels": 1,
      "hexChannels": 1,
      "hslChannels": 3
    }
  }
}

Error Handling

The API client provides comprehensive error handling through the TexttocolorAPIClientError exception. Here are some examples:

Basic Error Handling

from apiverve_texttocolor.apiClient import TexttocolorAPIClient, TexttocolorAPIClientError

api = TexttocolorAPIClient("[YOUR_API_KEY]")

query = { "color": "turquoise" }

try:
    result = api.execute(query)
    print("Success!")
    print(result)
except TexttocolorAPIClientError as e:
    print(f"API Error: {e.message}")
    if e.status_code:
        print(f"Status Code: {e.status_code}")
    if e.response:
        print(f"Response: {e.response}")

Handling Specific Error Types

from apiverve_texttocolor.apiClient import TexttocolorAPIClient, TexttocolorAPIClientError

api = TexttocolorAPIClient("[YOUR_API_KEY]")

query = { "color": "turquoise" }

try:
    result = api.execute(query)

    # Check for successful response
    if result.get('status') == 'success':
        print("Request successful!")
        print(result.get('data'))
    else:
        print(f"API returned an error: {result.get('error')}")

except TexttocolorAPIClientError as e:
    # Handle API client errors
    if e.status_code == 401:
        print("Unauthorized: Invalid API key")
    elif e.status_code == 429:
        print("Rate limit exceeded")
    elif e.status_code >= 500:
        print("Server error - please try again later")
    else:
        print(f"API error: {e.message}")
except Exception as e:
    # Handle unexpected errors
    print(f"Unexpected error: {str(e)}")

Using Context Manager (Recommended)

The client supports the context manager protocol for automatic resource cleanup:

from apiverve_texttocolor.apiClient import TexttocolorAPIClient, TexttocolorAPIClientError

query = { "color": "turquoise" }

# Using context manager ensures proper cleanup
with TexttocolorAPIClient("[YOUR_API_KEY]") as api:
    try:
        result = api.execute(query)
        print(result)
    except TexttocolorAPIClientError as e:
        print(f"Error: {e.message}")
# Session is automatically closed here

Advanced Features

Debug Mode

Enable debug logging to see detailed request and response information:

from apiverve_texttocolor.apiClient import TexttocolorAPIClient

# Enable debug mode
api = TexttocolorAPIClient("[YOUR_API_KEY]", debug=True)

query = { "color": "turquoise" }

# Debug information will be printed to console
result = api.execute(query)

Manual Session Management

If you need to manually manage the session lifecycle:

from apiverve_texttocolor.apiClient import TexttocolorAPIClient

api = TexttocolorAPIClient("[YOUR_API_KEY]")

query = { "color": "turquoise" }

try:
    result = api.execute(query)
    print(result)
finally:
    # Manually close the session when done
    api.close()

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 (©) 2026 APIVerve, and EvlarSoft 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_texttocolor-1.1.14.tar.gz (11.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

apiverve_texttocolor-1.1.14-py3-none-any.whl (10.4 kB view details)

Uploaded Python 3

File details

Details for the file apiverve_texttocolor-1.1.14.tar.gz.

File metadata

  • Download URL: apiverve_texttocolor-1.1.14.tar.gz
  • Upload date:
  • Size: 11.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.10

File hashes

Hashes for apiverve_texttocolor-1.1.14.tar.gz
Algorithm Hash digest
SHA256 5dceac27171400d106872a4a4a89098d17fd3b90a59a53cc903c014dd140104d
MD5 ec1a8b561c39928e40a45a43a64191ab
BLAKE2b-256 34a06f9385c18f846a88ad58dc2fe6e518adbf8e3d5b31598fde75dc8ea63e3a

See more details on using hashes here.

File details

Details for the file apiverve_texttocolor-1.1.14-py3-none-any.whl.

File metadata

File hashes

Hashes for apiverve_texttocolor-1.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 e7700559c8094cca78ba82c097c4a724a93192d2e208044deb9f6bfa9e2597e5
MD5 b1728699d8381c64021f908034ab43e9
BLAKE2b-256 7265a0515f3e3cb81d3f8c7390c1e08cc58cee0a13804bff2573b7d0420a28e1

See more details on using hashes here.

Supported by

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