cheminee

Cheminee - the Ruby gem for the Cheminée

Cheminée: The Chemical Structure Search Engine

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0
• Package version: 0.1.6
• Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://github.com/rdkit-rs/cheminee

Installation

Build a gem

To build the Ruby code into a gem:

gem build cheminee.gemspec

Then either install the gem locally:

gem install ./cheminee-0.1.6.gem

(for development, run gem install --dev ./cheminee-0.1.6.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'cheminee', '~> 0.1.6'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'cheminee', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'cheminee'

api_instance = Cheminee::DefaultApi.new

begin
  result = api_instance.v1_indexes_get
  p result
rescue Cheminee::ApiError => e
  puts "Exception when calling DefaultApi->v1_indexes_get: #{e}"
end

Documentation for API Endpoints

All URIs are relative to http://localhost:3000/api

Class	Method	HTTP request	Description
Cheminee::DefaultApi	v1_indexes_get	GET /v1/indexes
Cheminee::DefaultApi	v1_indexes_index_bulk_index_post	POST /v1/indexes/index/bulk_index
Cheminee::DefaultApi	v1_indexes_index_get	GET /v1/indexes/index
Cheminee::DefaultApi	v1_indexes_index_post	POST /v1/indexes/index
Cheminee::DefaultApi	v1_indexes_index_search_substructure_get	GET /v1/indexes/index/search/substructure
Cheminee::DefaultApi	v1_schemas_get	GET /v1/schemas
Cheminee::DefaultApi	v1_standardize_post	POST /v1/standardize

Documentation for Models

• Cheminee::BulkRequest
• Cheminee::BulkRequestDoc
• Cheminee::CreateIndexError
• Cheminee::GetIndexesResponseError
• Cheminee::IndexMeta
• Cheminee::ListIndexResponseErr
• Cheminee::PostIndexBulkResponseError
• Cheminee::PostIndexBulkResponseOk
• Cheminee::PostIndexBulkResponseOkStatus
• Cheminee::Schema
• Cheminee::Smile
• Cheminee::StandardizedSmile
• Cheminee::SubstructureSearchHit

Documentation for Authorization

Endpoints do not require authorization.