Skip to main content

Aspose.OMR Cloud SDK

Project description

Aspose.OMR for Cloud

Aspose.OMR for Cloud is a REST API that helps you to perform optical mark recognition in the cloud. We provide a series of SDKs. Along with that, you can get binaries to start working immediately and recognize various OMR forms.

Developers can embed optical recognition in any type of application to extract data from images of tests, exams, questionnaires, surveys, etc. In the repository you can find examples on how to start using Aspose.OMR API in your project.

How to use the SDK?

Our API is completely independent of your operating system, database system, or development language. You can use any language and platform that supports HTTP to interact with our API. However, manually writing client code can be difficult, error-prone, and time-consuming. Therefore, we have provided and support SDKs in many development languages to make it easier to integrate with us.

Examples

import asposeomrcloud.apis.storage_api as storage_api
from asposeomrcloud.configuration import Configuration
from asposeomrcloud.apis.omr_api import OmrApi
from asposeomrcloud.models import OmrFunctionParam

def run_demo():

    configuration = Configuration(apiKey=config.get('app_key'), appSid=config.get('app_sid'))

    api = OmrApi(configuration)
    storage = storage_api.StorageApi(configuration)

    # Step 1: Upload demo files on cloud and Generate template
    print("\t\tUploading demo files...")
    upload_demo_files(storage, data_dir)
    print("\t\tGenerate template...")
    res_gen = generate_template(api, storage, os.path.join(data_dir, TEMPLATE_DST_NAME), LOGOS_FOLDER_NAME)
    if res_gen.error_code == 0:
        deserialize_files(res_gen.payload.result.response_files, PATH_TO_OUTPUT)

    # Step 2: Validate template
    print("\t\tValidate template...")
    template_id = validate_template(api, storage, os.path.join(PATH_TO_OUTPUT, TEMPLATE_IMAGE_NAME), PATH_TO_OUTPUT)

    # Step 3: Recognize photos and scans
    print("\t\tRecognize image...")
    for user_image in TEMPLATE_USER_IMAGES_NAMES:
        res_rec = recognize_image(api, storage, template_id, os.path.join(data_dir, user_image))
        if res_rec.error_code == 0:
            result_file = deserialize_files(res_rec.payload.result.response_files, PATH_TO_OUTPUT)[0]
            print('Result file %s' % result_file)

Quickstart

Make your solution using SDK, follow these steps:

1. Clone from Github

Clone the solution using the command:

git clone git@github.com:aspose-omr-cloud/aspose-omr-cloud-python.git --recurse-submodules

2. Get API keys if you haven't

Make a personal account on Aspose Cloud Dashboard and click Get Keys. These keys are useful for all OMR Cloud products. If you have any trouble, look at this detailed manual.

3. Install SDK

Install aspose-omr-cloud with PIP from PyPI by:

pip install aspose-omr-cloud

Or clone repository and install it via Setuptools:

python setup.py install

4. Run Demo

  • Checkout the SDK or get from PyPi
  • Set Your AppSid & AppKey
  • Run run_demo.py

Structure

This project includes:

  • Module "asposeomrcloud", this is SDK. You can integrate it in your application. It contains both Omr and Storage API
  • Module "demo". Sample API requests.
  • Module "test", unittests. You can take a look at them to see various code examples.

Dependencies

  • See requirements.txt

Versions support:

  • Python :: 3.6
  • Python :: 3.7
  • Python :: 3.8
  • Python :: 3.9

OMR Cloud SDKs

.NET Java PHP Ruby Python Node.js Perl

Documentation for API Endpoints

All URIs are relative to https://api.aspose.cloud/v3.0

Class Method HTTP request Description
OmrApi post_run_omr_task POST /omr/{name}/runOmrTask Run specific OMR task

Authentication

Library uses OAUTH2 internally

Author

Aspose Pty Ltd (https://www.aspose.com)

Resources

Project details


Download files

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

Files for aspose-omr-cloud, version 20.10
Filename, size File type Python version Upload date Hashes
Filename, size aspose_omr_cloud-20.10-py3-none-any.whl (67.8 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page