Skip to content

Latest commit

 

History

History
47 lines (23 loc) · 1.82 KB

README.md

File metadata and controls

47 lines (23 loc) · 1.82 KB

Semantria SDK for Ruby

The Semantria SDKs are the most convenient way to integrate with the Semantria API to build a continuous or high-volume application. The SDKs implement all available Semantria features and include some simple examples of their use. However, the examples are not intended to demonstrate the best practices for processing large volumes of data. Please contact Lexalytics for guidance if you plan to build your own application.

For small volume, or ad-hoc, interactive data exploration check out Semantria for Excel.

See semantria.readme.io for complete API documentation.

If you find a bug or have suggestions let us know: support@lexaltyics.com. Or fork this repo, make your changes, and submit a pull request.

Installation

First, clone or download the SDK from https://github.com/Semantria/semantria-sdk.

Change directory into the Ruby directory. Then build the gem:

$ gem build semantria.gemspec

Install the gem:

$ gem install semantria_sdk-4.2.86.gem

Testing

We use the minitest testing framework. To install it:

$ gem install minitest

To run the SDK tests, first set the environment variables SEMANTRIA_KEY and SEMANTRIA_SECRET with your key and secret.

Then run the tests:

$ ruby test/unittests.rb

Running the examples

There are several example programs in the examples subdirectory.

First, ensure the environment variables SEMANTRIA_KEY and SEMANTRIA_SECRET are set.

Then run an example (the detailed example in this case):

$ ruby examples\detailed_mode_test_app.rb

Remember, these examples are coded in a simple style to illustrate the use of some of Semantria features. They do not represent the best practices for processing large volumes of data.