Metadata-Version: 2.1
Name: freehackquest-libclient-py
Version: 0.2.39
Summary: FreeHackQuest Python Client Library for fhq-server
Home-page: https://github.com/freehackquest/freehackquest-libclient-py
Author: FreeHackQuest Team
Author-email: freehackquest@gmail.com
License: UNKNOWN
Description: # 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 freehackquestclient
        ```
        
        or
        
        ```
        pip3 install freehackquestclient --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)
        
Keywords: ctf,fhq,fhq-server,libfreehackquest-client,jeopardy,freehackquest
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
