Skip to content

Mykrobe-tools/mykrobe-atlas-kmersearch-api-client

Repository files navigation

kmersearch_api_client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import kmersearch_api_client 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import kmersearch_api_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import kmersearch_api_client
from kmersearch_api_client.rest import ApiException
from pprint import pprint


# Defining host is optional and default to http://kmersearch-api-service/api/v1
configuration.host = "http://kmersearch-api-service/api/v1"
# Create an instance of the API class
api_instance = kmersearch_api_client.BuildApi(kmersearch_api_client.ApiClient(configuration))
new_samples = kmersearch_api_client.NewSamples() # NewSamples | 

try:
    api_response = api_instance.build_post(new_samples)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildApi->build_post: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://kmersearch-api-service/api/v1

Class Method HTTP request Description
BuildApi build_post POST /build
SearchApi search_post POST /search
VariantSearchApi variant_search_post POST /variant_search

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author

About

REST API client library for accessing Mykrobe Atlas Kmersearch API

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published