satisfactory-api-client 0.1.1__tar.gz

satisfactory_api_client-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Programmer-Timmy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

satisfactory_api_client-0.1.1/PKG-INFO

@@ -0,0 +1,189 @@
+Metadata-Version: 2.1
+Name: satisfactory_api_client
+Version: 0.1.1
+Summary: A Python Package for interacting with the Satisfactory Dedicated Server API
+Home-page: https://github.com/Programmer-Timmy/satisfactory-dedicated-server-api-SDK
+Author: Programmer-Timmy
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# Satisfactory Dedicated Server API Client
+
+This Python package provides a client for interacting with the Satisfactory Dedicated Server API. The client allows for managing various aspects of the server, including querying server state, logging in, adjusting game settings, handling save files, and issuing administrative commands.
+
+## Features
+
+- Perform health checks on the server
+- Log in with or without a password to obtain an authentication token
+- Query and modify server state and options
+- Manage advanced game settings
+- Create, load, save, and delete game sessions
+- Set client and admin passwords
+- Run server commands and shut down the server
+
+## Installation
+
+To install this package, use:
+
+```bash
+pip install satisfactory-api-client
+```
+
+## Requirements
+
+- Python 3.8+
+- `requests` library
+
+## Usage
+
+### Initializing the Client
+
+The `SatisfactoryAPI` class is the main entry point for interacting with the server API.
+
+```python
+from satisfactory_api_client import SatisfactoryAPI
+
+# Initialize the API client
+api = SatisfactoryAPI(host='your-server-ip', port=7777, auth_token='your-auth-token')
+```
+
+### Login
+
+You can log in to the server using passwordless or password-based methods.
+
+```python
+from satisfactory_api_client.data import MinimumPrivilegeLevel
+
+# Passwordless login
+response = api.passwordless_login(MinimumPrivilegeLevel.ADMIN)
+
+# Password login
+response = api.password_login(MinimumPrivilegeLevel.ADMIN, password='your-admin-password')
+```
+
+### Health Check
+
+To verify that the server is running and responsive, you can perform a health check:
+
+```python
+response = api.health_check()
+print(response.data)
+```
+
+### Server Options
+
+You can query the server's current options and apply new ones:
+
+```python
+# Get server options
+response = api.get_server_options()
+print(response.data)
+
+# Apply new server options
+new_options = {"server_name": "New Server Name"}
+response = api.apply_server_options(new_options)
+```
+
+### Advanced Game Settings
+
+Fetch and apply advanced game settings:
+
+```python
+from satisfactory_api_client.data import AdvancedGameSettings
+
+# Get advanced game settings
+response = api.get_advanced_game_settings()
+print(response.data)
+
+# Apply advanced game settings
+new_settings = AdvancedGameSettings(your_custom_settings)
+response = api.apply_advanced_game_settings(new_settings)
+```
+
+### Managing Game Sessions
+
+You can create, load, save, and delete game sessions.
+
+```python
+from satisfactory_api_client.data import NewGameData
+
+# Create a new game
+new_game_data = NewGameData(save_name="MyNewGame", ...)
+response = api.create_new_game(new_game_data)
+
+# Load a saved game
+response = api.load_game("MySaveGame")
+
+# Save the current game
+response = api.save_game("MySaveGame")
+
+# Delete a save file
+response = api.delete_save_file("MySaveGame")
+```
+
+### Running Commands and Managing the Server
+
+You can run commands on the server or shut it down:
+
+```python
+# Run a server command
+response = api.run_command("SomeCommand")
+
+# Shutdown the server
+response = api.shutdown()
+```
+
+## Methods
+
+### Authentication
+
+- `passwordless_login(minimum_privilege_level: MinimumPrivilegeLevel)`: Log in without a password.
+- `password_login(minimum_privilege_level: MinimumPrivilegeLevel, password: str)`: Log in using a password.
+
+### Server Management
+
+- `health_check(client_custom_data: str = '')`: Perform a health check on the server.
+- `shutdown()`: Shut down the server.
+
+### Game Management
+
+- `create_new_game(game_data: NewGameData)`: Create a new game session.
+- `load_game(save_name: str, enable_advanced_game_settings: bool = False)`: Load a saved game.
+- `save_game(save_name: str)`: Save the current game session.
+- `delete_save_file(save_name: str)`: Delete a saved game.
+- `enumerate_sessions()`: List all available game sessions.
+
+### Server Settings
+
+- `get_server_options()`: Get current server settings.
+- `apply_server_options(options: dict)`: Apply new server settings.
+- `get_advanced_game_settings()`: Get advanced game settings.
+- `apply_advanced_game_settings(settings: AdvancedGameSettings)`: Apply new advanced game settings.
+
+### Commands
+
+- `run_command(command: str)`: Run a server command.
+
+## Error Handling
+
+Errors returned by the API will raise an `APIError` exception, which contains the error message from the server.
+
+```python
+try:
+    response = api.some_method()
+except APIError as e:
+    print(f"Error: {e}")
+```
+
+## Contributing
+
+Contributions are welcome! If you find a bug or have a feature request, please create an issue on the GitHub repository.
+
+## License
+
+This project is licensed under the MIT License. See the LICENSE file for details.

satisfactory_api_client-0.1.1/README.md

@@ -0,0 +1,175 @@
+# Satisfactory Dedicated Server API Client
+
+This Python package provides a client for interacting with the Satisfactory Dedicated Server API. The client allows for managing various aspects of the server, including querying server state, logging in, adjusting game settings, handling save files, and issuing administrative commands.
+
+## Features
+
+- Perform health checks on the server
+- Log in with or without a password to obtain an authentication token
+- Query and modify server state and options
+- Manage advanced game settings
+- Create, load, save, and delete game sessions
+- Set client and admin passwords
+- Run server commands and shut down the server
+
+## Installation
+
+To install this package, use:
+
+```bash
+pip install satisfactory-api-client
+```
+
+## Requirements
+
+- Python 3.8+
+- `requests` library
+
+## Usage
+
+### Initializing the Client
+
+The `SatisfactoryAPI` class is the main entry point for interacting with the server API.
+
+```python
+from satisfactory_api_client import SatisfactoryAPI
+
+# Initialize the API client
+api = SatisfactoryAPI(host='your-server-ip', port=7777, auth_token='your-auth-token')
+```
+
+### Login
+
+You can log in to the server using passwordless or password-based methods.
+
+```python
+from satisfactory_api_client.data import MinimumPrivilegeLevel
+
+# Passwordless login
+response = api.passwordless_login(MinimumPrivilegeLevel.ADMIN)
+
+# Password login
+response = api.password_login(MinimumPrivilegeLevel.ADMIN, password='your-admin-password')
+```
+
+### Health Check
+
+To verify that the server is running and responsive, you can perform a health check:
+
+```python
+response = api.health_check()
+print(response.data)
+```
+
+### Server Options
+
+You can query the server's current options and apply new ones:
+
+```python
+# Get server options
+response = api.get_server_options()
+print(response.data)
+
+# Apply new server options
+new_options = {"server_name": "New Server Name"}
+response = api.apply_server_options(new_options)
+```
+
+### Advanced Game Settings
+
+Fetch and apply advanced game settings:
+
+```python
+from satisfactory_api_client.data import AdvancedGameSettings
+
+# Get advanced game settings
+response = api.get_advanced_game_settings()
+print(response.data)
+
+# Apply advanced game settings
+new_settings = AdvancedGameSettings(your_custom_settings)
+response = api.apply_advanced_game_settings(new_settings)
+```
+
+### Managing Game Sessions
+
+You can create, load, save, and delete game sessions.
+
+```python
+from satisfactory_api_client.data import NewGameData
+
+# Create a new game
+new_game_data = NewGameData(save_name="MyNewGame", ...)
+response = api.create_new_game(new_game_data)
+
+# Load a saved game
+response = api.load_game("MySaveGame")
+
+# Save the current game
+response = api.save_game("MySaveGame")
+
+# Delete a save file
+response = api.delete_save_file("MySaveGame")
+```
+
+### Running Commands and Managing the Server
+
+You can run commands on the server or shut it down:
+
+```python
+# Run a server command
+response = api.run_command("SomeCommand")
+
+# Shutdown the server
+response = api.shutdown()
+```
+
+## Methods
+
+### Authentication
+
+- `passwordless_login(minimum_privilege_level: MinimumPrivilegeLevel)`: Log in without a password.
+- `password_login(minimum_privilege_level: MinimumPrivilegeLevel, password: str)`: Log in using a password.
+
+### Server Management
+
+- `health_check(client_custom_data: str = '')`: Perform a health check on the server.
+- `shutdown()`: Shut down the server.
+
+### Game Management
+
+- `create_new_game(game_data: NewGameData)`: Create a new game session.
+- `load_game(save_name: str, enable_advanced_game_settings: bool = False)`: Load a saved game.
+- `save_game(save_name: str)`: Save the current game session.
+- `delete_save_file(save_name: str)`: Delete a saved game.
+- `enumerate_sessions()`: List all available game sessions.
+
+### Server Settings
+
+- `get_server_options()`: Get current server settings.
+- `apply_server_options(options: dict)`: Apply new server settings.
+- `get_advanced_game_settings()`: Get advanced game settings.
+- `apply_advanced_game_settings(settings: AdvancedGameSettings)`: Apply new advanced game settings.
+
+### Commands
+
+- `run_command(command: str)`: Run a server command.
+
+## Error Handling
+
+Errors returned by the API will raise an `APIError` exception, which contains the error message from the server.
+
+```python
+try:
+    response = api.some_method()
+except APIError as e:
+    print(f"Error: {e}")
+```
+
+## Contributing
+
+Contributions are welcome! If you find a bug or have a feature request, please create an issue on the GitHub repository.
+
+## License
+
+This project is licensed under the MIT License. See the LICENSE file for details.

satisfactory_api_client-0.1.1/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"

satisfactory_api_client-0.1.1/satisfactory_api_client/__init__.py

@@ -0,0 +1,3 @@
+import urllib3
+
+urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)

satisfactory_api_client-0.1.1/satisfactory_api_client/api_client.py

@@ -0,0 +1,546 @@
+from http.client import responses
+
+import requests
+
+from .data.advanced_game_settings import AdvancedGameSettings
+from .data.minimum_privilege_level import MinimumPrivilegeLevel
+from .data.new_game_save import NewGameData
+from .data.response import Response
+from .exceptions import APIError
+
+
+class SatisfactoryAPI:
+    """ A client for the Satisfactory Dedicated Server API """
+
+    def __init__(self, host: str, port: int = 7777, auth_token: str = None):
+        """
+        Initialize the API client
+
+        Parameters
+        ----------
+        host : str
+            The hostname or IP address of the server
+        port : int, optional
+            The port to connect to, by default 7777
+        auth_token : str, optional
+            The authentication token, by default None.
+            You can use the `password_login` or `passwordless_login` methods to request a token from the server.
+
+        Raises
+        ------
+        APIError
+            If the authentication token is invalid
+        """
+        self.host: str = host
+        self.port: int = port
+        self.auth_token: str | None = auth_token
+
+        if self.auth_token:
+            self.verify_authentication_token()
+
+    def _post(self, function, data=None, files=None):
+        """
+        Post a request to the API
+
+        :param function: The function to call
+        :param data: The data to send
+        :param files: The files to send
+        :return: The response
+        :rtype: dict
+
+        :raises APIError: If the API returns an error
+        """
+        url = f"https://{self.host}:{self.port}/api/v1"
+        headers = {'Content-Type': 'application/json'}
+
+        if self.auth_token:
+            headers['Authorization'] = f'Bearer {self.auth_token}'
+
+        payload = {'function': function, 'data': data} if data else {'function': function}
+
+        response = requests.post(url, json=payload, headers=headers, files=files, verify=False)
+        if response.status_code != 200 and response.status_code != 204:
+            raise APIError(f"API error: {response.text}")
+
+        if response.status_code == 204:
+            return {}
+
+        if response.json().get('errorCode'):
+            raise APIError(response.json().get('errorMessage'))
+        return response.json()
+
+    def _get(self, function, data=None):
+        """
+        Get a request to the API
+
+        :param function: The function to call
+        :param data: The data to send
+        :return: The response
+        :rtype: dict
+
+        :raises APIError: If the API returns an error
+        """
+        url = f"https://{self.host}:{self.port}/api/v1"
+        headers = {'Content-Type': 'application/json'}
+
+        if self.auth_token:
+            headers['Authorization'] = f'Bearer {self.auth_token}'
+
+        payload = {'function': function, 'data': data} if data else {'function': function}
+
+        response = requests.get(url, json=payload, headers=headers, verify=False)
+        if response.status_code != 200 and response.status_code != 204:
+            raise APIError(f"API error: {response.text}")
+
+        if response.status_code == 204:
+            return {}
+
+        if response.json().get('errorCode'):
+            raise APIError(response.json().get('errorMessage'))
+        return response.json()
+
+    def health_check(self, client_custom_data='') -> (
+            Response):
+        """
+        Perform a health check on the server. This function is used to check if the server is running and if the API is.
+
+        Parameters
+        ----------
+        client_custom_data : str
+            Custom data to send to the server. Defaults to an empty string.
+
+        Returns
+        -------
+        Response
+            A Response containing the data returned by the API.
+
+        Raises
+        ------
+        APIError
+            If the API returns an error
+        """
+        response = self._post('HealthCheck', {'ClientCustomData': client_custom_data})
+        return Response(success=True, data=response)
+
+    def verify_authentication_token(self) -> Response:
+        """
+        Verify the authentication token
+
+        Returns
+        -------
+        Response
+            A Response containing the message 'Token is valid'.
+
+        Raises
+        ------
+        APIError
+            If the API returns an error or if the token is invalid.
+        """
+        self._post('VerifyAuthenticationToken')
+        return Response(success=True, data={'message': 'Token is valid'})
+
+    def passwordless_login(self, minimum_privilege_level: MinimumPrivilegeLevel) -> Response:
+        """
+        Perform a passwordless login and store the authentication token.
+
+        Parameters
+        ----------
+        minimum_privilege_level : MinimumPrivilegeLevel
+            The minimum privilege level required for the login.
+
+        Returns
+        -------
+        Response
+            A Response containing the message 'Successfully logged in, the token is now stored'.
+
+        Raises
+        ------
+        APIError
+            If the API returns an error or if the login is unsuccessful
+            (e.g., incorrect password or insufficient privileges).
+        """
+        response = self._post('PasswordlessLogin', {'MinimumPrivilegeLevel': minimum_privilege_level.value})
+        self.auth_token = response['data']['authenticationToken']
+        return Response(success=True, data=self.auth_token)
+
+    def password_login(self, minimum_privilege_level: MinimumPrivilegeLevel, password: str) -> Response:
+        """
+        Perform a password login and store the authentication token.
+
+        Parameters
+        ----------
+        minimum_privilege_level : MinimumPrivilegeLevel
+            The minimum privilege level required for the login.
+        password : str
+            The password associated with the account. Must not be empty.
+
+        Returns
+        -------
+        Response
+            A Response containing the message 'Successfully logged in, the token is now stored'.
+
+        Raises
+        ------
+        APIError
+            If the API returns an error or if the login is unsuccessful
+            (e.g., incorrect password or insufficient privileges).
+        """
+        response = self._post('PasswordLogin', {
+            'MinimumPrivilegeLevel': minimum_privilege_level.value,
+            'Password': password
+        })
+        self.auth_token = response['data']['authenticationToken']
+        return Response(success=True, data={'message': 'Successfully logged in, the token is now stored'})
+
+    def query_server_state(self):
+        """
+        Query the server state
+
+        Returns
+        -------
+        Response
+            A Response containing the server state data.
+
+        Raises
+        ------
+        APIError
+            If the API returns an error.
+        """
+        response = self._post('QueryServerState')
+        return Response(success=True, data=response)
+
+    def get_server_options(self):
+        """
+        Get the server options
+
+        Returns
+        -------
+        Response
+            A Response containing the server options data.
+
+        Raises
+        ------
+        APIError
+            If the API returns an error.
+        """
+        response = self._post('GetServerOptions')
+        return Response(success=True, data=response)
+
+    def get_advanced_game_settings(self) -> Response:
+        """
+        Fetch advanced game settings.
+
+        Returns
+        -------
+        Response
+            A Response containing the advanced game settings.
+        """
+        response = self._get('GetAdvancedGameSettings')
+        return Response(success=True, data=response['data'])
+
+    def apply_advanced_game_settings(self, settings: AdvancedGameSettings) -> Response:
+        """
+        Apply advanced game settings.
+
+        Parameters
+        ----------
+        settings : AdvancedGameSettings
+            The new advanced game settings to apply.
+
+        Returns
+        -------
+        Response
+            A Response indicating the success of the operation.
+        """
+        response = self._post('ApplyAdvancedGameSettings', {
+            'AppliedAdvancedGameSettings': settings.__dict__  # Convert dataclass to dict
+        })
+        return Response(success=True, data=response['data'])
+
+    def claim_server(self, server_name: str, admin_password: str) -> Response:
+        """
+        Claim the server.
+
+        Parameters
+        ----------
+        server_name : str
+            The name of the server.
+        admin_password : str
+            The administrator password.
+
+        Returns
+        -------
+        Response
+            A Response containing the server claim result.
+        """
+        response = self._post('ClaimServer', {
+            'ServerName': server_name,
+            'AdminPassword': admin_password
+        })
+        return Response(success=True, data=response['data'])
+
+    def rename_server(self, server_name: str) -> Response:
+        """
+        Rename the server.
+
+        Parameters
+        ----------
+        server_name : str
+            The new name for the server.
+
+        Returns
+        -------
+        Response
+            A Response indicating the success of the operation.
+        """
+        response = self._post('RenameServer', {
+            'ServerName': server_name
+        })
+        return Response(success=True, data=response['data'])
+
+    def set_client_password(self, password: str) -> Response:
+        """
+        Set the client password.
+
+        Parameters
+        ----------
+        password : str
+            The new client password.
+
+        Returns
+        -------
+        Response
+            A Response indicating the success of the operation.
+        """
+        response = self._post('SetClientPassword', {
+            'Password': password
+        })
+        return Response(success=True, data=response['data'])
+
+    def set_admin_password(self, password: str, auth_token: str) -> Response:
+        """
+        Set the admin password.
+
+        Parameters
+        ----------
+        password : str
+            The new admin password.
+        auth_token : str
+            The authentication token.
+
+        Returns
+        -------
+        Response
+            A Response indicating the success of the operation.
+        """
+        response = self._post('SetAdminPassword', {
+            'Password': password,
+            'AuthenticationToken': auth_token
+        })
+        return Response(success=True, data=response['data'])
+
+    def set_auto_load_session_name(self, session_name: str) -> Response:
+        """
+        Set the auto-load session name.
+
+        Parameters
+        ----------
+        session_name : str
+            The session name to auto-load.
+
+        Returns
+        -------
+        Response
+            A Response indicating the success of the operation.
+        """
+        response = self._post('SetAutoLoadSessionName', {
+            'SessionName': session_name
+        })
+        return Response(success=True, data=response['data'])
+
+    def run_command(self, command: str) -> Response:
+        """
+        Run a server command.
+
+        Parameters
+        ----------
+        command : str
+            The command to run.
+
+        Returns
+        -------
+        Response
+            A Response containing the result of the command.
+        """
+        response = self._post('RunCommand', {
+            'Command': command
+        })
+        return Response(success=True, data=response['data'])
+
+    def shutdown(self) -> Response:
+        """
+        Shut down the server.
+
+        Returns
+        -------
+        Response
+            A Response indicating the success of the operation.
+        """
+        response = self._post('Shutdown')
+        return Response(success=True, data=response['data'])
+
+    def apply_server_options(self, options: dict) -> Response:
+        """
+        Apply server options.
+
+        Parameters
+        ----------
+        options : dict
+            The server options to apply.
+
+        Returns
+        -------
+        Response
+            A Response indicating the success of the operation.
+        """
+        response = self._post('ApplyServerOptions', {
+            'UpdatedServerOptions': options
+        })
+        return Response(success=True, data=response['data'])
+
+    def create_new_game(self, game_data: NewGameData) -> Response:
+        """
+        Create a new game.
+
+        Parameters
+        ----------
+        game_data : NewGameData
+            The data for the new game.
+
+        Returns
+        -------
+        Response
+            A Response indicating the success of the operation.
+        """
+        response = self._post('CreateNewGame', {
+            'NewGameData': game_data.__dict__  # Convert dataclass to dict
+        })
+        return Response(success=True, data=response['data'])
+
+    def save_game(self, save_name: str) -> Response:
+        """
+        Save the game.
+
+        Parameters
+        ----------
+        save_name : str
+            The name of the save file.
+
+        Returns
+        -------
+        Response
+            A Response indicating the success of the save operation.
+        """
+        response = self._post('SaveGame', {
+            'SaveName': save_name
+        })
+        return Response(success=True, data=response['data'])
+
+    def delete_save_file(self, save_name: str) -> Response:
+        """
+        Delete a save file.
+
+        Parameters
+        ----------
+        save_name : str
+            The name of the save file to delete.
+
+        Returns
+        -------
+        Response
+            A Response indicating the success of the operation.
+        """
+        response = self._post('DeleteSaveFile', {
+            'SaveName': save_name
+        })
+        return Response(success=True, data=response['data'])
+
+    def delete_save_session(self, session_name: str) -> Response:
+        """
+        Delete a save session.
+
+        Parameters
+        ----------
+        session_name : str
+            The name of the session to delete.
+
+        Returns
+        -------
+        Response
+            A Response indicating the success of the operation.
+        """
+        response = self._post('DeleteSaveSession', {
+            'SessionName': session_name
+        })
+        return Response(success=True, data=response['data'])
+
+    def enumerate_sessions(self) -> Response:
+        """
+        Enumerate available sessions.
+
+        Returns
+        -------
+        Response
+            A Response containing the available sessions.
+        """
+        response = self._get('EnumerateSessions')
+        return Response(success=True, data=response['data'])
+
+    def load_game(self, save_name: str, enable_advanced_game_settings: bool = False) -> Response:
+        """
+        Load a saved game.
+
+        Parameters
+        ----------
+        save_name : str
+            The name of the save file to load.
+        enable_advanced_game_settings : bool, optional
+            Whether to enable advanced game settings (default is False).
+
+        Returns
+        -------
+        Response
+            A Response indicating the success of the load operation.
+        """
+        response = self._post('LoadGame', {
+            'SaveName': save_name,
+            'EnableAdvancedGameSettings': enable_advanced_game_settings
+        })
+        return Response(success=True, data=response['data'])
+
+    def upload_save_game(self, save_name: str, load_save_game: bool = False,
+                         enable_advanced_game_settings: bool = False) -> Response:
+        raise NotImplementedError('This method is not implemented yet')
+
+    def download_save_game(self, save_name: str) -> Response:
+        """
+        Download a save game file.
+
+        Parameters
+        ----------
+        save_name : str
+            The name of the save file to download.
+
+        Returns
+        -------
+        Response
+            A Response indicating the success of the download operation.
+        """
+        response = self._get('DownloadSaveGame', {
+            'SaveName': save_name
+        })
+        return Response(success=True, data=response['data'])
+
+
+
+

satisfactory_api_client-0.1.1/satisfactory_api_client/data/advanced_game_settings.py

@@ -0,0 +1,12 @@
+import dataclasses
+@dataclasses.dataclass
+class AdvancedGameSettings:
+    """
+    Advanced game settings for a Satisfactory Dedicated Server
+
+    Attributes
+    ----------
+    some_setting : str
+        A setting for the server
+    """
+    some_setting: str  # Replace with actual settings fields

satisfactory_api_client-0.1.1/satisfactory_api_client/data/minimum_privilege_level.py

@@ -0,0 +1,9 @@
+from enum import Enum
+
+
+class MinimumPrivilegeLevel(Enum):
+    NOT_AUTHENTICATED = 'NotAuthenticated'
+    CLIENT = 'Client'
+    ADMINISTRATOR = 'Administrator'
+    INITIAL_ADMIN = 'InitialAdmin'
+    API_TOKEN = 'APIToken'

satisfactory_api_client-0.1.1/satisfactory_api_client/data/new_game_save.py

@@ -0,0 +1,31 @@
+from dataclasses import dataclass
+from typing import Optional
+from .advanced_game_settings import AdvancedGameSettings
+
+
+@dataclass
+class NewGameData:
+    """
+    New game data for a Satisfactory Dedicated Server
+
+    Attributes
+    ----------
+    SessionName : str
+        The name of the session
+    MapName : Optional[str]
+        The name of the map
+    StartingLocation : Optional[str]
+        The starting location of the session
+    SkipOnboarding : Optional[bool]
+        Whether to skip the onboarding process
+    AdvancedGameSettings : Optional[AdvancedGameSettings]
+        Advanced game settings for the server
+    CustomOptionsOnlyForModding : Optional[dict]
+        Custom options only for mod
+    """
+    SessionName: str
+    MapName: Optional[str] = None
+    StartingLocation: Optional[str] = None
+    SkipOnboarding: Optional[bool] = None
+    AdvancedGameSettings: Optional[AdvancedGameSettings] = None
+    CustomOptionsOnlyForModding: Optional[dict] = None

satisfactory_api_client-0.1.1/satisfactory_api_client/data/response.py

@@ -0,0 +1,7 @@
+import dataclasses
+
+
+@dataclasses.dataclass
+class Response:
+    success: bool
+    data: dict

satisfactory_api_client-0.1.1/satisfactory_api_client/exceptions.py

@@ -0,0 +1,7 @@
+class APIError(Exception):
+    """Exception raised for API errors."""
+    pass
+
+class InvalidParameterError(APIError):
+    """Exception raised for invalid parameters."""
+    pass

satisfactory_api_client-0.1.1/satisfactory_api_client/utils.py

@@ -0,0 +1,3 @@
+def validate_parameters(api_function, data):
+    # Implement validation logic here
+    pass

satisfactory_api_client-0.1.1/satisfactory_api_client.egg-info/PKG-INFO

@@ -0,0 +1,189 @@
+Metadata-Version: 2.1
+Name: satisfactory-api-client
+Version: 0.1.1
+Summary: A Python Package for interacting with the Satisfactory Dedicated Server API
+Home-page: https://github.com/Programmer-Timmy/satisfactory-dedicated-server-api-SDK
+Author: Programmer-Timmy
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# Satisfactory Dedicated Server API Client
+
+This Python package provides a client for interacting with the Satisfactory Dedicated Server API. The client allows for managing various aspects of the server, including querying server state, logging in, adjusting game settings, handling save files, and issuing administrative commands.
+
+## Features
+
+- Perform health checks on the server
+- Log in with or without a password to obtain an authentication token
+- Query and modify server state and options
+- Manage advanced game settings
+- Create, load, save, and delete game sessions
+- Set client and admin passwords
+- Run server commands and shut down the server
+
+## Installation
+
+To install this package, use:
+
+```bash
+pip install satisfactory-api-client
+```
+
+## Requirements
+
+- Python 3.8+
+- `requests` library
+
+## Usage
+
+### Initializing the Client
+
+The `SatisfactoryAPI` class is the main entry point for interacting with the server API.
+
+```python
+from satisfactory_api_client import SatisfactoryAPI
+
+# Initialize the API client
+api = SatisfactoryAPI(host='your-server-ip', port=7777, auth_token='your-auth-token')
+```
+
+### Login
+
+You can log in to the server using passwordless or password-based methods.
+
+```python
+from satisfactory_api_client.data import MinimumPrivilegeLevel
+
+# Passwordless login
+response = api.passwordless_login(MinimumPrivilegeLevel.ADMIN)
+
+# Password login
+response = api.password_login(MinimumPrivilegeLevel.ADMIN, password='your-admin-password')
+```
+
+### Health Check
+
+To verify that the server is running and responsive, you can perform a health check:
+
+```python
+response = api.health_check()
+print(response.data)
+```
+
+### Server Options
+
+You can query the server's current options and apply new ones:
+
+```python
+# Get server options
+response = api.get_server_options()
+print(response.data)
+
+# Apply new server options
+new_options = {"server_name": "New Server Name"}
+response = api.apply_server_options(new_options)
+```
+
+### Advanced Game Settings
+
+Fetch and apply advanced game settings:
+
+```python
+from satisfactory_api_client.data import AdvancedGameSettings
+
+# Get advanced game settings
+response = api.get_advanced_game_settings()
+print(response.data)
+
+# Apply advanced game settings
+new_settings = AdvancedGameSettings(your_custom_settings)
+response = api.apply_advanced_game_settings(new_settings)
+```
+
+### Managing Game Sessions
+
+You can create, load, save, and delete game sessions.
+
+```python
+from satisfactory_api_client.data import NewGameData
+
+# Create a new game
+new_game_data = NewGameData(save_name="MyNewGame", ...)
+response = api.create_new_game(new_game_data)
+
+# Load a saved game
+response = api.load_game("MySaveGame")
+
+# Save the current game
+response = api.save_game("MySaveGame")
+
+# Delete a save file
+response = api.delete_save_file("MySaveGame")
+```
+
+### Running Commands and Managing the Server
+
+You can run commands on the server or shut it down:
+
+```python
+# Run a server command
+response = api.run_command("SomeCommand")
+
+# Shutdown the server
+response = api.shutdown()
+```
+
+## Methods
+
+### Authentication
+
+- `passwordless_login(minimum_privilege_level: MinimumPrivilegeLevel)`: Log in without a password.
+- `password_login(minimum_privilege_level: MinimumPrivilegeLevel, password: str)`: Log in using a password.
+
+### Server Management
+
+- `health_check(client_custom_data: str = '')`: Perform a health check on the server.
+- `shutdown()`: Shut down the server.
+
+### Game Management
+
+- `create_new_game(game_data: NewGameData)`: Create a new game session.
+- `load_game(save_name: str, enable_advanced_game_settings: bool = False)`: Load a saved game.
+- `save_game(save_name: str)`: Save the current game session.
+- `delete_save_file(save_name: str)`: Delete a saved game.
+- `enumerate_sessions()`: List all available game sessions.
+
+### Server Settings
+
+- `get_server_options()`: Get current server settings.
+- `apply_server_options(options: dict)`: Apply new server settings.
+- `get_advanced_game_settings()`: Get advanced game settings.
+- `apply_advanced_game_settings(settings: AdvancedGameSettings)`: Apply new advanced game settings.
+
+### Commands
+
+- `run_command(command: str)`: Run a server command.
+
+## Error Handling
+
+Errors returned by the API will raise an `APIError` exception, which contains the error message from the server.
+
+```python
+try:
+    response = api.some_method()
+except APIError as e:
+    print(f"Error: {e}")
+```
+
+## Contributing
+
+Contributions are welcome! If you find a bug or have a feature request, please create an issue on the GitHub repository.
+
+## License
+
+This project is licensed under the MIT License. See the LICENSE file for details.

satisfactory_api_client-0.1.1/satisfactory_api_client.egg-info/SOURCES.txt

@@ -0,0 +1,24 @@
+LICENSE
+README.md
+pyproject.toml
+setup.py
+examples/__init__.py
+satisfactory_api_client/__init__.py
+satisfactory_api_client/api_client.py
+satisfactory_api_client/config.py
+satisfactory_api_client/exceptions.py
+satisfactory_api_client/models.py
+satisfactory_api_client/utils.py
+satisfactory_api_client.egg-info/PKG-INFO
+satisfactory_api_client.egg-info/SOURCES.txt
+satisfactory_api_client.egg-info/dependency_links.txt
+satisfactory_api_client.egg-info/requires.txt
+satisfactory_api_client.egg-info/top_level.txt
+satisfactory_api_client/data/__init__.py
+satisfactory_api_client/data/advanced_game_settings.py
+satisfactory_api_client/data/minimum_privilege_level.py
+satisfactory_api_client/data/new_game_save.py
+satisfactory_api_client/data/response.py
+tests/__init__.py
+tests/test_api_client.py
+tests/test_api_functions.py

satisfactory_api_client-0.1.1/satisfactory_api_client.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

satisfactory_api_client-0.1.1/satisfactory_api_client.egg-info/requires.txt

@@ -0,0 +1,3 @@
+python-dotenv~=1.0.1
+urllib3~=2.2.3
+requests~=2.32.3

satisfactory_api_client-0.1.1/satisfactory_api_client.egg-info/top_level.txt

@@ -0,0 +1,3 @@
+examples
+satisfactory_api_client
+tests

satisfactory_api_client-0.1.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

satisfactory_api_client-0.1.1/setup.py

@@ -0,0 +1,20 @@
+from setuptools import setup, find_packages
+
+setup(
+    name='satisfactory_api_client',
+    version='0.1.1',
+    packages=find_packages(),
+    install_requires=[req.strip() for req in open('requirements.txt').readlines()],
+    description='A Python Package for interacting with the Satisfactory Dedicated Server API',
+    long_description=open('README.md').read(),
+    long_description_content_type='text/markdown',
+    url='https://github.com/Programmer-Timmy/satisfactory-dedicated-server-api-SDK',  # Replace with your repo URL
+    author='Programmer-Timmy',
+    license='MIT',
+    classifiers=[
+        'Programming Language :: Python :: 3',
+        'License :: OSI Approved :: MIT License',
+        'Operating System :: OS Independent',
+    ],
+    python_requires='>=3.6',
+)

satisfactory_api_client-0.1.1/tests/test_api_client.py

@@ -0,0 +1,18 @@
+import unittest
+from satisfactory_api_client.api_client import SatisfactoryAPI
+class TestAPIClient(unittest.TestCase):
+    def test_initialization(self):
+        client = SatisfactoryAPI("localhost")
+        self.assertEqual(client.host, "localhost")
+        self.assertEqual(client.port, 7777)
+
+    def test_initialization_with_port(self):
+        client = SatisfactoryAPI("localhost", port=1234)
+        self.assertEqual(client.port, 1234)
+
+    def test_post(self):
+       pass
+
+
+if __name__ == "__main__":
+    unittest.main()

satisfactory_api_client-0.1.1/tests/test_api_functions.py

@@ -0,0 +1,17 @@
+import os
+import unittest
+
+class TestApiFunctions(unittest.TestCase):
+    def test_health_check(self):
+       pass
+
+    def test_passwordless_login(self):
+        pass
+
+    def test_password_login(self):
+        pass
+    def test_verify_authentication_token(self):
+        pass
+
+if __name__ == "__main__":
+    unittest.main()