Skip to main content

ASCII85 Encoder is a tool for encoding and decoding data using ASCII85 (also known as Base85) encoding. It supports both standard and btoa formats for efficient binary-to-text encoding with better compression than Base64.

Project description

ASCII85 Encoder API

ASCII85 Encoder is a tool for encoding and decoding data using ASCII85 (also known as Base85) encoding. It supports both standard and btoa formats for efficient binary-to-text encoding with better compression than Base64.

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the ASCII85 Encoder API


Installation

Using pip:

pip install apiverve-ascii85encoder

Using pip3:

pip3 install apiverve-ascii85encoder

Configuration

Before using the ascii85encoder 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_ascii85encoder.apiClient import Ascii85encoderAPIClient

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

query = {
    "text": "Hello World",
    "action": "encode",
    "format": "standard"
}

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

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

Usage

The ASCII85 Encoder API documentation is found here: https://docs.apiverve.com/ref/ascii85encoder. You can find parameters, example responses, and status codes documented here.

Setup

# Import the client module
from apiverve_ascii85encoder.apiClient import Ascii85encoderAPIClient

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

Perform Request

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

Define Query
query = {
    "text": "Hello World",
    "action": "encode",
    "format": "standard"
}
Simple Request
# Make a request to the API
result = api.execute(query)

# Print the result
print(result)
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "original_text": "Hello World",
    "encoded": "87cURD]i,\"Ebo7",
    "format": "standard",
    "original_length": 11,
    "encoded_length": 14,
    "compression_ratio": "127.27%"
  }
}

Error Handling

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

Basic Error Handling

from apiverve_ascii85encoder.apiClient import Ascii85encoderAPIClient, Ascii85encoderAPIClientError

api = Ascii85encoderAPIClient("[YOUR_API_KEY]")

query = {
    "text": "Hello World",
    "action": "encode",
    "format": "standard"
}

try:
    result = api.execute(query)
    print("Success!")
    print(result)
except Ascii85encoderAPIClientError 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_ascii85encoder.apiClient import Ascii85encoderAPIClient, Ascii85encoderAPIClientError

api = Ascii85encoderAPIClient("[YOUR_API_KEY]")

query = {
    "text": "Hello World",
    "action": "encode",
    "format": "standard"
}

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 Ascii85encoderAPIClientError 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_ascii85encoder.apiClient import Ascii85encoderAPIClient, Ascii85encoderAPIClientError

query = {
    "text": "Hello World",
    "action": "encode",
    "format": "standard"
}

# Using context manager ensures proper cleanup
with Ascii85encoderAPIClient("[YOUR_API_KEY]") as api:
    try:
        result = api.execute(query)
        print(result)
    except Ascii85encoderAPIClientError 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_ascii85encoder.apiClient import Ascii85encoderAPIClient

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

query = {
    "text": "Hello World",
    "action": "encode",
    "format": "standard"
}

# 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_ascii85encoder.apiClient import Ascii85encoderAPIClient

api = Ascii85encoderAPIClient("[YOUR_API_KEY]")

query = {
    "text": "Hello World",
    "action": "encode",
    "format": "standard"
}

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_ascii85encoder-1.1.14.tar.gz (11.1 kB view details)

Uploaded Source

Built Distribution

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

apiverve_ascii85encoder-1.1.14-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for apiverve_ascii85encoder-1.1.14.tar.gz
Algorithm Hash digest
SHA256 5d8f2fd0b93a9fa1767ac449028cc7639c7972abd3a63d1278fe0b0e21c77883
MD5 6ccdd3403c585dced2a6d24f3d9be431
BLAKE2b-256 6006079089917c25a5fefbe1e7de336a80cb6b0cd9a663b7252345b1d0ed2ee5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for apiverve_ascii85encoder-1.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 7e4eecc5fab1865265617d1f5cba804d937b6cef75fd1b23b080e93b35a8b4bd
MD5 d8a34cef10fcec307625e1aef58406b8
BLAKE2b-256 25ab6d9884b8bc7f679fdcb373008c9e2c8cbef29b4ebb86c54a433fbcbb0b5a

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