Skip to main content

Roman Numeral Converter is a bidirectional tool for converting between Arabic numbers (1-3999) and Roman numerals. It provides detailed breakdowns of the conversion process.

Project description

Roman Numeral Converter API

Roman Numeral Converter is a bidirectional tool for converting between Arabic numbers (1-3999) and Roman numerals. It provides detailed breakdowns of the conversion process.

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the Roman Numeral Converter API


Installation

Using pip:

pip install apiverve-romannumeralconverter

Using pip3:

pip3 install apiverve-romannumeralconverter

Configuration

Before using the romanconverter 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_romannumeralconverter.apiClient import RomanconverterAPIClient

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

query = { "number": 2024 }

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

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

Usage

The Roman Numeral Converter API documentation is found here: https://docs.apiverve.com/ref/romanconverter. You can find parameters, example responses, and status codes documented here.

Setup

# Import the client module
from apiverve_romannumeralconverter.apiClient import RomanconverterAPIClient

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

Perform Request

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

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

# Print the result
print(result)
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "number": 2024,
    "roman": "MMXXIV",
    "breakdown": {
      "M": 2,
      "X": 2,
      "IV": 1
    }
  }
}

Error Handling

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

Basic Error Handling

from apiverve_romannumeralconverter.apiClient import RomanconverterAPIClient, RomanconverterAPIClientError

api = RomanconverterAPIClient("[YOUR_API_KEY]")

query = { "number": 2024 }

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

api = RomanconverterAPIClient("[YOUR_API_KEY]")

query = { "number": 2024 }

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 RomanconverterAPIClientError 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_romannumeralconverter.apiClient import RomanconverterAPIClient, RomanconverterAPIClientError

query = { "number": 2024 }

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

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

query = { "number": 2024 }

# 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_romannumeralconverter.apiClient import RomanconverterAPIClient

api = RomanconverterAPIClient("[YOUR_API_KEY]")

query = { "number": 2024 }

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_romannumeralconverter-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_romannumeralconverter-1.1.14-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for apiverve_romannumeralconverter-1.1.14.tar.gz
Algorithm Hash digest
SHA256 5b464d08a8e3e6bae2c49792c69a12e9b6a58c3c3f01186612c2e1af5264a855
MD5 d7bfd8cfd75aaa471765618186ec749e
BLAKE2b-256 75580bedc4164de6a030326d9bf87effa38fcef2094b0c6ac44da7a0253d7b28

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for apiverve_romannumeralconverter-1.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 15333e55f4c0b999ecd0aa5170af8c1aacaed3961a4ed503a06dd1da510ea173
MD5 cee63885f5128750349f157f899f59fd
BLAKE2b-256 6c3e99626e16e4e7a6ebd29c978c51d2c5c8d184c8f8c8826711c4d12caed97d

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