Metadata-Version: 2.1
Name: sspanel
Version: 0.1.0
Summary: Simple API for the SurvivalServers.com Control Panel using HTTP requests.
Home-page: https://github.com/chr-ibb/sspanel
Author: Christopher Ibbotson
Author-email: me@chribbotson.com
License: MIT
Description: 
        # SSPanel
        
        **SSPanel** is a simple API providing the basic functionality of the **[SurvivalServers.com](https://www.survivalservers.com/)** Control Panel to Python  
        via HTTPS requests. It allows for starting, stopping, and restarting a server, as well as retrieving server info.  
        
        ```python
        >>> import sspanel
        >>> username, password, subuser = "aUserName", "aP@ssw0rd", False
        >>> serverid = 123456
        
        # Start the server. 
        >>> sspanel.start(username, password, subuser, serverid)
        'Server is started'
        
        # Retrieve basic server information.
        >>> info = sspanel.info(username, password, subuser, serverid)
        'Info gathered'
        >>> print(info)
        'title: ServerTitle'
        'status: Started, Ready'
        'players: 3/22'
        'last start: 04/1/2021 04:20:00'
        'game version: v0.123.4'
        'ip address: 111.111.11.11'
        'game port: 9876'
        'query port: 9877'
        
        # Alternatively: create a ControlPanel object; make sequential calls with the same server. 
        >>> panel = sspanel.ControlPanel(username, password, subuser, serverid)
        >>> panel.restart()
        'Server is started'
        
        >>> panel.stop()
        'Server is stopped'
        
        ```
        
        ## Main Interface
        
        - sspanel.**start**(username, password, subuser, serverid)  
            - Attempts to start the server described by the credentials passed in.
        
        - sspanel.**stop**(username, password, subuser, serverid)  
            - Attempts to stop the server described by the credentials passed in.
        
        - sspanel.**restart**(username, password, subuser, serverid)  
            - Attempts to restart the server described by the credentials passed in.
        
        - sspanel.**info**(username, password, subuser, serverid)  
            - Attempts to retrieve and return info about the server described by the credentials passed in.
            - **Returns:** a ServerInfo object.
        
        ## Classes
        
        - sspanel.**ControlPanel**(username, password, subuser, serverid)  
            - #TODO
        
        - sspanel.**ServerInfo**  
            - #TODO
        
        ## Etc
        
        Only tested with a Valheim server; that is all I have access to. 
        
        Makes use of the [Requests](https://github.com/psf/requests) library.
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.6.0
Description-Content-Type: text/markdown
