schrodinger.application.pldb.packages.pldbclient.api

Class Api

object --+ | Api

A python interface into the Schrodinger API Usage: import schrodinger api=schrodinger.Api(endpoint='http://server:port', username='username', password='password')

Instance Methods

[hide private]

__init__(self, endpoint, username=None, password=None)
Instantiate a new schrodinger.Api object.

create_file_type(self, file_type, filename)

get_attribute_metadata(self)

search_attributes(self, namespace, key, query_string)

get_server_settings(self)

get_structure_codes(self, highwater_pk=0, updated_at=None)
gets all unique structure codes from the server

file_types(self)

try_create_filetype(self, file_type, filename)
tries to create file_type, if it already exists, return all file_types

structures(self, params=None, structure_id=None)

query_forms(self, params=None)

delete_query(self, query_id)

delete_structures_by_code(self, code)

create_query(self, filename=None, data=None)
either a file or data can be specified, file is the name of the file path, and data is the data string

fragment_query(self, fragment_mae)

get_query(self, query_id)

get_result_csv(self, query_id)

stop_query(self, query_id)

change_query_title(self, query_id, new_title)

get_query_results(self, query_id, highwater_pk=None, offset=None)

advanced_upload(self, unique_code, files, pipeline=None, origin='advanced_upload', parent_structure_id=None)

upload_file(self, unique_code, pdb_filename=None, ligand_filename=None, prealigned_family=None, access_projects=None, map_dict=None)

get_structure_file(self, structure_id, file_type)

delete_structure(self, structure_id)

add_file(self, structure_id, file_type, file_name)

reimport(self, structure_id)

upload_livedesign(self, mapping_data, prjzip_file)

create_attribute(self, structure_id, json_file)

create_attribute_from_dict(self, structure_id, data_dict)

create_alignment_family(self, family_name, structure_id, chain_name)

launch_pipeline(self, structure_id, pipeline_name)

create_project(self, project_name)

delete_project(self, project_id)

add_structures_to_project(self, project_id, structure_ids)

remove_structures_from_project(self, project_id, structure_ids)

add_user_to_project(self, project_id, username)

remove_user_from_project(self, project_id, username)

add_group_to_project(self, project_id, group_id)

remove_group_from_project(self, project_id, group_id)

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

init(self, endpoint, username=None, password=None)
(Constructor)

Instantiate a new schrodinger.Api object.

Parameters:

endpoint (string) - url of schrodinger server, e.g. ('http://localhost:8000')
username (string) - HTTP basic auth username for accessing the server
password (string) - HTTP basic auth password

Overrides: object.__init__

Class Api

__init__(self, endpoint, username=None, password=None) (Constructor)

init(self, endpoint, username=None, password=None)
(Constructor)