# timbr REST API connector sample file
This project is a sample connecting to timbr using REST API from Python.
## Dependencies
- Python 3.7.13+ or 3.8.x or 3.9.x
## Installation
- Install as clone repository:
- Install Python: https://www.python.org/downloads/release/python-3713/
- Install using pip and git:
- `pip install git+https://github.com/WPSemantix/timbr_python_http`
- Install using pip:
- `pip install PyTimbrRestAPI`
## Sample usage
- For an example of how to use the REST API connector for Timbr, follow this [Example file](example.py)
## Execute query with http connection
```python
# For http connections
response = PyTimbrRestAPI.executeQuery(hostname='<TIMBR_IP/HOST>', port='<TIMBR_PORT>', ontology='<ONTOLOGY_NAME>', token='<USER_TOKEN>', query='<TIMBR_QUERY>', nested='<true/false>')
# hostname - The IP / Hostname of the Timbr platform.
# port - Timbr default port 443
# ontology - the ontology / knowledge graph to connect to.
# token - Timbr token value.
# query - The query that you want to execute.
# nested - Change to true if nested flag needs to be enabled.
print(response)
```
## Execute query with https connection
```python
# For http connections
response = PyTimbrRestAPI.securedExecuteQuery(hostname='<TIMBR_IP/HOST>', port='<TIMBR_PORT>', ontology='<ONTOLOGY_NAME>', token='<USER_TOKEN>', query='<TIMBR_QUERY>', nested='<true/false>')
# hostname - The IP / Hostname of the Timbr platform.
# port - Timbr default port 443
# ontology - the ontology / knowledge graph to connect to.
# token - Timbr token value.
# query - The query that you want to execute.
# nested - Change to true if nested flag needs to be enabled.
print(response)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/WPSemantix/timbr_python_http",
"name": "PyTimbrRestAPI",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "timbr,timbr-http,timbr-https,timbr-rest,timbr-api,timbr-rest-api,timbr-connector,PyTimbrRestAPI,PyTimbr",
"author": "timbr",
"author_email": "contact@timbr.ai",
"download_url": "https://files.pythonhosted.org/packages/54/d6/4b5c811621f179caa2797d69195c58ecc28386ef7e800e835dd200425df7/PyTimbrRestAPI-1.0.0.tar.gz",
"platform": null,
"description": "\r\n\r\n# timbr REST API connector sample file\r\nThis project is a sample connecting to timbr using REST API from Python.\r\n\r\n## Dependencies\r\n- Python 3.7.13+ or 3.8.x or 3.9.x\r\n\r\n## Installation\r\n- Install as clone repository:\r\n - Install Python: https://www.python.org/downloads/release/python-3713/\r\n\r\n- Install using pip and git:\r\n - `pip install git+https://github.com/WPSemantix/timbr_python_http`\r\n\r\n- Install using pip:\r\n - `pip install PyTimbrRestAPI`\r\n\r\n## Sample usage\r\n- For an example of how to use the REST API connector for Timbr, follow this [Example file](example.py)\r\n\r\n## Execute query with http connection\r\n ```python\r\n # For http connections\r\n response = PyTimbrRestAPI.executeQuery(hostname='<TIMBR_IP/HOST>', port='<TIMBR_PORT>', ontology='<ONTOLOGY_NAME>', token='<USER_TOKEN>', query='<TIMBR_QUERY>', nested='<true/false>')\r\n\r\n # hostname - The IP / Hostname of the Timbr platform.\r\n # port - Timbr default port 443\r\n # ontology - the ontology / knowledge graph to connect to.\r\n # token - Timbr token value.\r\n # query - The query that you want to execute.\r\n # nested - Change to true if nested flag needs to be enabled.\r\n\r\n print(response)\r\n```\r\n\r\n## Execute query with https connection\r\n ```python\r\n # For http connections\r\n response = PyTimbrRestAPI.securedExecuteQuery(hostname='<TIMBR_IP/HOST>', port='<TIMBR_PORT>', ontology='<ONTOLOGY_NAME>', token='<USER_TOKEN>', query='<TIMBR_QUERY>', nested='<true/false>')\r\n\r\n # hostname - The IP / Hostname of the Timbr platform.\r\n # port - Timbr default port 443\r\n # ontology - the ontology / knowledge graph to connect to.\r\n # token - Timbr token value.\r\n # query - The query that you want to execute.\r\n # nested - Change to true if nested flag needs to be enabled.\r\n\r\n print(response)\r\n```\r\n\r\n\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Timbr REST API connector",
"version": "1.0.0",
"project_urls": {
"Bug Tracker": "https://github.com/WPSemantix/timbr_python_http/issues",
"Homepage": "https://github.com/WPSemantix/timbr_python_http"
},
"split_keywords": [
"timbr",
"timbr-http",
"timbr-https",
"timbr-rest",
"timbr-api",
"timbr-rest-api",
"timbr-connector",
"pytimbrrestapi",
"pytimbr"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "54d64b5c811621f179caa2797d69195c58ecc28386ef7e800e835dd200425df7",
"md5": "dac30ed4b0a9db21a2c3a10f0a96d177",
"sha256": "a7d7a015cdbeb582b205ce4c531499c6360c5a7be98d7b811a62c2e7297a0592"
},
"downloads": -1,
"filename": "PyTimbrRestAPI-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "dac30ed4b0a9db21a2c3a10f0a96d177",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3324,
"upload_time": "2023-06-20T12:54:03",
"upload_time_iso_8601": "2023-06-20T12:54:03.191789Z",
"url": "https://files.pythonhosted.org/packages/54/d6/4b5c811621f179caa2797d69195c58ecc28386ef7e800e835dd200425df7/PyTimbrRestAPI-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-20 12:54:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "WPSemantix",
"github_project": "timbr_python_http",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pytimbrrestapi"
}
JSON
