feat: new method to upload an app, function to create config file and refactor in the routes system to add a decorator "on_request" '-'

Author: robert-nogueira

README.md

@@ -1,28 +1,39 @@
 [SquareCloud]: https://squarecloud.app
+
 [API]: https://docs.squarecloud.app/api/introducao
-[@alma]: https://github.com/Robert-Nogueira
 
+[@alma]: https://github.com/Robert-Nogueira
 
 # squarecloud-api
+
 squarecloud-api is a wrapper of the [API] of [SquareCloud] made by [@alma]
 
 ## Installing
+
 ````
 pip install squarecloud-api
 ````
 
 ## Starting
+
 ### Where to get my api key?
-to get your api key/token just go to the [SquareCloud] website and register/login, after that go to `dashboard` > `my account` > `Regenerate API/CLI KEY` and copy the key.
+
+to get your api key/token just go to the [SquareCloud] website and
+register/login, after that go
+to `dashboard` > `my account` > `Regenerate API/CLI KEY` and copy the key.
 
 ### The client instance
+
 with the client you can get information about your application
+
 ````python
 import squarecloud as square
 
 client = square.Client(api_key='API KEY')
 
 app_id = 'application id'
+
+
 async def example():
     logs = await client.get_logs(app_id)
     print(logs)
@@ -39,7 +50,9 @@ async def example():
     print(status.storage)
 
 ````
+
 you can also manage your application
+
 ````python
 import squarecloud as square
 
@@ -48,6 +61,8 @@ import squarecloud as square
 client = square.Client(api_key='API KEY')
 
 app_id = 'application id'
+
+
 async def example():
     await client.backup(app_id)
     await client.start_app(app_id)
@@ -57,13 +72,18 @@ async def example():
     await client.commit(app_id, file=square.File('path/to/your/file'))
 
 ````
+
 ### Application object
-Using the client you can also get an application or a list of applications and use them to manage your application.
+
+Using the client you can also get an application or a list of applications and
+use them to manage your application.
+
 ````python
 import squarecloud as square
 
 client = square.Client(api_key='API KEY')
 
+
 async def example():
     app = await client.app('application id')
 
@@ -75,7 +95,7 @@ async def example():
     print(status.network)
     print(status.running)
     print(status.storage)
-    
+
     # managing
     await app.stop()
     await app.start()
@@ -84,19 +104,89 @@ async def example():
     await app.delete()
     await app.backup()
     await app.commit(square.File('path/to/your/file'))
-    
+
     apps_list = await client.all_apps()
     for app in apps_list:
         print(app)
 
 ````
+
+### Uploading an application
+
+to upload an application you need of a zip contain the following files:
+
+- the main file: the file responsible to start the application
+- the dependency file: contains information about with dependencies need to be
+  installed
+- the configuration file(squarecloud.app): a configuration file to upload, for
+  more information take a look at [this link](https://docs.squarecloud.app/suporte/como-hospedar#configurando-sua-aplicacao)
+
+```python
+import squarecloud as square
+
+client = square.Client(api_key='API KEY')
+
+
+async def example():
+    await client.upload_app(square.File('path/to/my_file.zip'))
+```
+for your convenience a function was added to create the configuration file
+
+```python
+import squarecloud as square
+
+# application example
+square.create_config_file(
+    path='directory/to/save/', # the path where the file should be saved
+    display_name='an cool name',
+    description='an cool description',
+    main='main.py',
+    memory=100,
+    version='recommended',
+)
+
+# website example
+square.create_config_file(
+    path='directory/to/save',
+    display_name='cool website',
+    description='this is really cool',
+    main='index.js',
+    subdomain='coolwebsite.squareweb.app',
+    start='start this cool website', # if not static it is configurable
+    memory=512,
+    version='recommended',
+)
+
+"""
+[REQUIRED] parameters
+---------------------
+path: str
+display_name: str
+main: str
+memory: int
+version: Literal['recommended', 'latest']
+
+[OPTIONAL] parameters
+---------------------
+avatar: str | None = None
+description: str | None = None
+subdomain: str | None = None
+start: str | None = None
+"""
+```
+
+
 ### Debug mode
-Every time a request is made logs are displayed in the terminal containing useful informations, You can disable this by setting the `debug` parameter to False for the client, this value by default is True.
+Every time a request is made logs are displayed in the terminal containing
+useful information, You can disable this by setting the `debug` parameter to
+False for the client, this value by default is True.
+
 ````py
 import squarecloud as square
 
-client = square.Client(api_key='API KEY', debug=False) # no logs
+client = square.Client(api_key='API KEY', debug=False)  # no logs
 ````
 
 ## License
+
 MIT License

squarecloud/__init__.py

@@ -1,3 +1,4 @@
-from .client import Client
+from .client import Client, create_config_file
 from .square import File
 from .errors import *
+from .http import Routes

squarecloud/client.py

@@ -3,7 +3,7 @@
 
 import logging
 from abc import ABC, abstractmethod
-from typing import List
+from typing import List, Literal, Any, Callable
 
 from .data import (
     AppData,
@@ -13,10 +13,10 @@
     BackupData,
     CompleteLogsData,
 )
-from .http import HTTPClient, Response
+from .http import HTTPClient, Response, Routes
 from .logs import logger
 from .square import File, Application
-from .errors import ApplicationNotFound
+from .errors import ApplicationNotFound, InvalidFile
 from .types import (
     UserPayload,
     StatusPayload,
@@ -35,6 +35,55 @@ def api_key(self):
         """get the api token"""
 
 
+def create_config_file(
+        display_name: str,
+        main: str,
+        memory: int,
+        version: Literal['recommended', 'latest'],
+        path: str,
+        avatar: str | None = None,
+        description: str | None = None,
+        subdomain: str | None = None,
+        start: str | None = None
+):
+    """
+    Creates a config file (squarecloud.app)
+    Args:
+
+        display_name: name of your application
+        main: name of your main file
+        memory: amount of memory to be allocated
+        version: version of python and node.js, you can choose between
+        'recommended' and 'latest'
+        avatar: your application avatar url
+        description: your application description
+        subdomain: subdomain of your application
+        start: the command to start your application
+        path: the path where the file should be saved
+
+    Returns:
+        TextIOWrapper
+    """
+    content: str = ''
+    optionals: dict[str, Any] = {
+        'DISPLAY_NAME': display_name,
+        'MAIN': main,
+        'MEMORY': memory,
+        'VERSION': version,
+        'AVATAR': avatar,
+        'DESCRIPTION': description,
+        'SUBDOMAIN': subdomain,
+        'START': start,
+    }
+    for key, value in optionals.items():
+        if value is not None:
+            string: str = f'{key}={value}\n'
+            content += string
+    with open(f'./{path}/squarecloud.app', 'w') as f:
+        f.write(content)
+        return f
+
+
 class Client(AbstractClient):
     """A client for interacting with the SquareCloud API."""
 
@@ -49,6 +98,7 @@ def __init__(self, api_key: str, debug: bool = True) -> None:
         self.debug = debug
         self._api_key = api_key
         self.__http = HTTPClient(api_key=api_key)
+        self._listeners: dict[Routes, Callable]
         if self.debug:
             logger.setLevel(logging.DEBUG)
 
@@ -212,3 +262,13 @@ async def all_apps(self) -> List[Application]:
         apps: List[Application] = [Application(client=self, data=data) for data
                                    in apps_data]
         return apps
+
+    async def upload_app(self, zip: File, check_zip: bool = True):
+        if not isinstance(zip, File):
+            raise InvalidFile(
+                f'you need provide an {File.__name__} object')
+        elif zip.name.split('.')[-1] != 'zip':
+            raise InvalidFile('the file must be a .zip file')
+        await self.__http.upload(zip)
+
+    # async def on_request(self):

squarecloud/errors.py

@@ -20,3 +20,15 @@ class BadRequestError(RequestError):
 
 class ApplicationNotFound(SquareException):
     """raises when an application is not found"""
+
+
+class InvalidFile(SquareException):
+    """raised when a file is invalid"""
+
+
+class MissingConfigFile(RequestError):
+    """raised when the configuration file is missing"""
+
+
+class MissingDependenciesFile(RequestError):
+    """raised when the configuration file is missing"""