Python library for calling TERMite and TExpress and processing results
Project description
Project Description
Python library for making calls to SciBite's TERMite, TExpress and DOCstore The library also enables post-processing of the JSON returned from such requests.
Install
$ pip3 install termite_toolkit
Versions listed on PyPi!
Example call to TERMite
from termite_toolkit import termite
from pprint import pprint
# specify termite API endpoint
termite_home = "http://localhost:9090/termite"
# specify entities to annotate
entities = "DRUG"
# initialise a request builder
t = termite.TermiteRequestBuilder()
# individually add items to your TERMite request
t.set_url(termite_home)
t.set_fuzzy(True)
t.set_text("citrate macrophage colony sildenafil stimulating factor influenza hedgehog")
t.set_entities(entities)
t.set_subsume(True)
t.set_input_format("txt")
t.set_output_format("doc.jsonx")
t.set_reject_ambiguous(False)
t.set_options({'fragmentSize': 20})
# execute the request
termite_response = t.execute(display_request=True)
pprint(termite_response)
Example call to TExpress
from pprint import pprint
from termite_toolkit import texpress
# specify termite API endpoint
termite_home = "http://localhost:9090/termite"
# specify the pattern you wish to search for- this can created in the TERMite UI
pattern = ":(INDICATION):{0,5}:(GENE)"
t = texpress.TexpressRequestBuilder()
# individually add items to your TERMite request
t.set_url(termite_home)
t.set_text("breast cancer brca1")
t.set_subsume(True)
t.set_input_format("txt")
t.set_output_format("json")
t.set_allow_ambiguous(False)
t.set_pattern(pattern)
# execute the request
texpress_response = t.execute(display_request=True)
pprint(texpress_response)
Example call to DOCstore
from termite_toolkit import docstore
# Document co-occurrence of a list of entities
docs = docstore.DocStoreRequestBuilder()
# specify docstore API endpoint and add authentication if necessary
docs.set_url('docstore_address')
docs.set_basic_auth(username='user', password='pw')
# make call to DOCStore
docs_json = docs.get_dcc_docs(['id:GENE$HTT', 'id:GENE$EGFR'], '*', {})
# convert json to df
df = docstore.get_docstore_dcc_df(docs_json)
# print titles of hits
print(df['title'])
License
Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
termite_toolkit-0.4.2.tar.gz
(20.0 kB
view hashes)
Built Distribution
Close
Hashes for termite_toolkit-0.4.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cf4c5aa2a7429c8d45e15e00fefe3ef41302f0e11f8063781c524f8153ce0459 |
|
MD5 | 5a3251e75c2f005b93a696cf8277270f |
|
BLAKE2b-256 | f4539305bb20b52caad70e43ceefbe198be7c2c54bad7b2f28b9e8e497942c49 |