freehackquest-libclient-py

Name	freehackquest-libclient-py JSON
Version	0.2.54 JSON
	download
home_page	https://github.com/freehackquest/freehackquest-libclient-py
Summary	FreeHackQuest Python Client Library for fhq-server
upload_time	2025-08-21 14:18:55
maintainer	None
docs_url	None
author	FreeHackQuest Team
requires_python	>=3.6
license	None
keywords	ctf fhq fhq-server libfreehackquest-client jeopardy freehackquest
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # freehackquest-libcliet-py

![PyPI](https://img.shields.io/pypi/v/freehackquest-libclient-py) [![Total alerts](https://img.shields.io/lgtm/alerts/g/freehackquest/freehackquest-libclient-py.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/freehackquest/freehackquest-libclient-py/alerts/) [![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/freehackquest/freehackquest-libclient-py.svg?logo=lgtm&logoWidth=18)](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": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": "ctf, fhq, fhq-server, libfreehackquest-client, jeopardy, freehackquest",
    "author": "FreeHackQuest Team",
    "author_email": "freehackquest@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/19/29/3eb3115375d54070f0c820832087f63d9dc91b09aca65d20eb446e5b49b8/freehackquest-libclient-py-0.2.54.tar.gz",
    "platform": null,
    "description": "# freehackquest-libcliet-py\n\n![PyPI](https://img.shields.io/pypi/v/freehackquest-libclient-py) [![Total alerts](https://img.shields.io/lgtm/alerts/g/freehackquest/freehackquest-libclient-py.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/freehackquest/freehackquest-libclient-py/alerts/) [![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/freehackquest/freehackquest-libclient-py.svg?logo=lgtm&logoWidth=18)](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": null,
    "summary": "FreeHackQuest Python Client Library for fhq-server",
    "version": "0.2.54",
    "project_urls": {
        "Homepage": "https://github.com/freehackquest/freehackquest-libclient-py"
    },
    "split_keywords": [
        "ctf",
        " fhq",
        " fhq-server",
        " libfreehackquest-client",
        " jeopardy",
        " freehackquest"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "56ca7b823431716301c173f9f8d492ed431f00043b19b38fe633e92043f425f1",
                "md5": "3ed43fa3b90e82416657b5599893f1a5",
                "sha256": "0b84eb9de768ec793b275e1df8e4814de1c60926da81f2da1b5ef7a8c89df2bc"
            },
            "downloads": -1,
            "filename": "freehackquest_libclient_py-0.2.54-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3ed43fa3b90e82416657b5599893f1a5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 22259,
            "upload_time": "2025-08-21T14:18:54",
            "upload_time_iso_8601": "2025-08-21T14:18:54.127456Z",
            "url": "https://files.pythonhosted.org/packages/56/ca/7b823431716301c173f9f8d492ed431f00043b19b38fe633e92043f425f1/freehackquest_libclient_py-0.2.54-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "19293eb3115375d54070f0c820832087f63d9dc91b09aca65d20eb446e5b49b8",
                "md5": "44861fc4ffd07feb7c5962b6a884f5d4",
                "sha256": "4ce02dca700689f769f24e0406f1e80b73efd9e598dada953db860b34195f7a0"
            },
            "downloads": -1,
            "filename": "freehackquest-libclient-py-0.2.54.tar.gz",
            "has_sig": false,
            "md5_digest": "44861fc4ffd07feb7c5962b6a884f5d4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 18565,
            "upload_time": "2025-08-21T14:18:55",
            "upload_time_iso_8601": "2025-08-21T14:18:55.652741Z",
            "url": "https://files.pythonhosted.org/packages/19/29/3eb3115375d54070f0c820832087f63d9dc91b09aca65d20eb446e5b49b8/freehackquest-libclient-py-0.2.54.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-21 14:18:55",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "freehackquest",
    "github_project": "freehackquest-libclient-py",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "freehackquest-libclient-py"
}