# freehackquest-libcliet-py
 [](https://lgtm.com/projects/g/freehackquest/freehackquest-libclient-py/alerts/) [](https://lgtm.com/projects/g/freehackquest/freehackquest-libclient-py/context:python)
FreeHackQuest Python Client Library for fhq-server: [https://github.com/freehackquest/fhq-server.git](https://github.com/freehackquest/fhq-server.git)
## Install
```
pip3 install freehackquest-libclient-py
```
or
```
pip3 install freehackquest-libclient-py --upgrade
```
## Example code
```
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
from freehackquest_libclient_py import FreeHackQuestClient
fhq = FreeHackQuestClient("ws://freehackquest.com:1234/ws-api/")
q = fhq.quest({"questid": 148})
print("quest: " + str(q))
# or "ws://freehackquest.com:1234" or "ws://freehackquest.com/ws-api/"
resp = fhq.login({"email": "admin", "password": "admin"})
if resp == None:
print('Could not login as user (1)')
if resp['result'] == 'FAIL':
print('Could not login as user (1)')
print("user info: " + str(resp))
```
Full description API here: [API.md](./API.md)
Raw data
{
"_id": null,
"home_page": "https://github.com/freehackquest/freehackquest-libclient-py",
"name": "freehackquest-libclient-py",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "ctf,fhq,fhq-server,libfreehackquest-client,jeopardy,freehackquest",
"author": "FreeHackQuest Team",
"author_email": "freehackquest@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/3c/ab/7eed300a428d8cf747c3a94e4972c7597c64e05a41dba2db5ba963bea955/freehackquest-libclient-py-0.2.51.tar.gz",
"platform": null,
"description": "# freehackquest-libcliet-py\n\n [](https://lgtm.com/projects/g/freehackquest/freehackquest-libclient-py/alerts/) [](https://lgtm.com/projects/g/freehackquest/freehackquest-libclient-py/context:python)\n\n\nFreeHackQuest Python Client Library for fhq-server: [https://github.com/freehackquest/fhq-server.git](https://github.com/freehackquest/fhq-server.git)\n\n## Install\n\n```\npip3 install freehackquest-libclient-py\n```\n\nor\n\n```\npip3 install freehackquest-libclient-py --upgrade\n```\n\n## Example code\n\n```\n#!/usr/bin/env python3\n# -*- coding: utf-8 -*-\n\nfrom freehackquest_libclient_py import FreeHackQuestClient\n\nfhq = FreeHackQuestClient(\"ws://freehackquest.com:1234/ws-api/\")\n\nq = fhq.quest({\"questid\": 148})\nprint(\"quest: \" + str(q))\n\n# or \"ws://freehackquest.com:1234\" or \"ws://freehackquest.com/ws-api/\"\nresp = fhq.login({\"email\": \"admin\", \"password\": \"admin\"})\nif resp == None:\n print('Could not login as user (1)')\n\nif resp['result'] == 'FAIL':\n print('Could not login as user (1)')\n\nprint(\"user info: \" + str(resp))\n```\n\nFull description API here: [API.md](./API.md)\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "FreeHackQuest Python Client Library for fhq-server",
"version": "0.2.51",
"split_keywords": [
"ctf",
"fhq",
"fhq-server",
"libfreehackquest-client",
"jeopardy",
"freehackquest"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "78dbf59bbd83ca810f6c43552a6234329cf4c133ed3ddd665a3076f5fd7a8168",
"md5": "418b9d0ef7c2e204feb3a29a82a870e4",
"sha256": "c6b898e2e2f70966341d755ffff4f23dea346dd1b70518e40ecbf3a54292f21d"
},
"downloads": -1,
"filename": "freehackquest_libclient_py-0.2.51-py3-none-any.whl",
"has_sig": false,
"md5_digest": "418b9d0ef7c2e204feb3a29a82a870e4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 21239,
"upload_time": "2023-01-03T17:09:03",
"upload_time_iso_8601": "2023-01-03T17:09:03.732647Z",
"url": "https://files.pythonhosted.org/packages/78/db/f59bbd83ca810f6c43552a6234329cf4c133ed3ddd665a3076f5fd7a8168/freehackquest_libclient_py-0.2.51-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3cab7eed300a428d8cf747c3a94e4972c7597c64e05a41dba2db5ba963bea955",
"md5": "443ac346e6564957e4ee5daaa04c3402",
"sha256": "354772942bc2e573975f5d8900366b241bf555341310ff8e388fb2a2fb59affc"
},
"downloads": -1,
"filename": "freehackquest-libclient-py-0.2.51.tar.gz",
"has_sig": false,
"md5_digest": "443ac346e6564957e4ee5daaa04c3402",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 18316,
"upload_time": "2023-01-03T17:09:05",
"upload_time_iso_8601": "2023-01-03T17:09:05.828747Z",
"url": "https://files.pythonhosted.org/packages/3c/ab/7eed300a428d8cf747c3a94e4972c7597c64e05a41dba2db5ba963bea955/freehackquest-libclient-py-0.2.51.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-03 17:09:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "freehackquest",
"github_project": "freehackquest-libclient-py",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "freehackquest-libclient-py"
}
JSON
