Merge pull request #16 from Jhonatan-Jeferson/main

New addition, fixes, deprecations and adding docstrings

Author: JoaoOtavioS

examples/env/delete_env/with_app.py

@@ -0,0 +1,13 @@
+import asyncio
+
+from squarecloud import Client
+
+client = Client(api_key="your_api_key")
+
+async def main():
+    app = await client.app("your_app_id")
+    keys = [] # The keys you want to delete
+    result = await app.delete_envs(keys) # Deletes the specified environment variables
+    print("Remaining env variables: ", result) 
+
+asyncio.run(main())

examples/env/delete_env/with_client.py

@@ -0,0 +1,13 @@
+import asyncio
+
+from squarecloud import Client
+
+client = Client(api_key="your_api_key")
+
+
+async def main():
+    keys = []  # The keys you want to delete
+    result = await client.delete_app_envs("app_id", keys) # Deletes the specified environment variables
+    print("Remaining env variables: ", result)
+
+asyncio.run(main())

examples/env/get_env/with_app.py

@@ -0,0 +1,13 @@
+import asyncio
+
+from squarecloud import Client
+
+client = Client(api_key="your_api_key")
+
+
+async def main():
+    app = await client.app("your_app_id")
+    envs = await app.get_envs()
+    print("App envs: ", envs)
+
+asyncio.run(main())

examples/env/get_env/with_client.py

@@ -0,0 +1,12 @@
+import asyncio
+
+from squarecloud import Client
+
+client = Client(api_key="your_api_key")
+
+
+async def main():
+    envs = await client.get_app_envs("app_id")
+    print("App envs: ", envs)
+
+asyncio.run(main())

examples/env/overwrite_env/with_app.py

@@ -0,0 +1,14 @@
+import asyncio
+
+from squarecloud import Client
+
+client = Client(api_key="your_api_key")
+
+
+async def main():
+    app = await client.app("your_app_id")
+    envs = {"KEY": "VALUE"} # The new environment variables
+    result = await app.overwrite_env(envs) # Overwrites all environment variables and sets only the new ones
+    print("Overwrite envs result: ", result)
+
+asyncio.run(main())

examples/env/overwrite_env/with_client.py

@@ -0,0 +1,13 @@
+import asyncio
+
+from squarecloud import Client
+
+client = Client(api_key="your_api_key")
+
+
+async def main():
+    envs = {"ONLY_THIS": "present"} # The new environment variables
+    result = await client.overwrite_app_envs("app_id", envs) # Overwrites all environment variables and sets only the new ones
+    print("Overwrite envs result:", result)
+
+asyncio.run(main())

examples/env/set_env/with_app.py

@@ -0,0 +1,14 @@
+import asyncio
+
+from squarecloud import Client
+
+client = Client(api_key="your_api_key")
+
+
+async def main():
+    envs = {"KEY": "VALUE"} # The environment variables you want to set
+    app = await client.app("your_app_id")
+    result = await app.set_envs(envs) # Sets or updates the specified environment variables
+    print("Set envs result:", result)
+
+asyncio.run(main())

examples/env/set_env/with_client.py

@@ -0,0 +1,13 @@
+import asyncio
+
+from squarecloud import Client
+
+client = Client(api_key="your_api_key")
+
+
+async def main():
+    envs = {"KEY": "VALUE"} # The environment variables you want to set
+    result = await client.set_app_envs("app_id", envs) # Sets or updates the specified environment variables
+    print("Set envs result:", result)
+
+asyncio.run(main())

examples/backup/with_application.py renamed to examples/snapshots/with_application.py

@@ -7,8 +7,7 @@
 
 async def example() -> None:
     app = await client.app('application_id')
-    backup = await app.backup()
-    print(backup.url)  # https://squarecloud.app/dashboard/backup/f.zip
-
+    snapshot = await app.snapshot()
+    print(snapshot.url)  # https://squarecloud.app/dashboard/backup/f.zip
 
 asyncio.run(example())

examples/backup/with_client.py renamed to examples/snapshots/with_client.py

@@ -6,8 +6,8 @@
 
 
 async def example() -> None:
-    backup = await client.backup('application_id')
-    print(backup.url)  # https://squarecloud.app/dashboard/backup/f.zip
+    snapshot = await client.snapshot('application_id')
+    print(snapshot.url)  # https://squarecloud.app/dashboard/backup/f.zip
 
 
 asyncio.run(example())