pythonanywhere-core 0.2.4__py3-none-any.whl → 0.2.6__py3-none-any.whl

pythonanywhere_core/__init__.py

@@ -1 +1 @@
-__version__ = "0.2.4"
+__version__ = "0.2.6"

pythonanywhere_core/webapp.py

@@ -4,6 +4,7 @@ import os
 import getpass
 from pathlib import Path
 from textwrap import dedent
+from typing import Any
 
 from dateutil.parser import parse
 from snakesay import snakesay
@@ -21,16 +22,25 @@ class Webapp:
 
     Methods:
         - :meth:`Webapp.create`: Create a new webapp.
+        - :meth:`Webapp.create_static_file_mapping`: Create a static file mapping.
+        - :meth:`Webapp.add_default_static_files_mappings`: Add default static files mappings.
         - :meth:`Webapp.reload`: Reload the webapp.
         - :meth:`Webapp.set_ssl`: Set the SSL certificate and private key.
         - :meth:`Webapp.get_ssl_info`: Retrieve SSL certificate information.
         - :meth:`Webapp.delete_log`: Delete a log file.
         - :meth:`Webapp.get_log_info`: Retrieve log file information.
+        - :meth:`Webapp.get`: Retrieve webapp information.
+        - :meth:`Webapp.delete`: Delete webapp.
+        - :meth:`Webapp.patch`: Patch webapp.
+
+    Class Methods:
+        - :meth:`Webapp.list_webapps`: List all webapps for the current user.
     """
+    username = getpass.getuser()
+    files_url = get_api_endpoint(username=username, flavor="files")
+    webapps_url = get_api_endpoint(username=username, flavor="webapps")
+
     def __init__(self, domain: str) -> None:
-        self.username = getpass.getuser()
-        self.files_url = get_api_endpoint(username=self.username, flavor="files")
-        self.webapps_url = get_api_endpoint(username=self.username, flavor="webapps")
         self.domain = domain
         self.domain_url = f"{self.webapps_url}{self.domain}/"
 
@@ -38,7 +48,12 @@ class Webapp:
         return self.domain == other.domain
 
     def sanity_checks(self, nuke: bool) -> None:
-        """Check that we have a token, and that we don't already have a webapp for this domain"""
+        """Check that we have a token, and that we don't already have a webapp for this domain.
+
+        :param nuke: if True, skip the check for existing webapp
+
+        :raises SanityException: if API token is missing or webapp already exists
+        """
         print(snakesay("Running API sanity checks"))
         token = os.environ.get("API_TOKEN")
         if not token:
@@ -71,7 +86,6 @@ class Webapp:
 
         :raises PythonAnywhereApiException: if API call fails
         """
-        print(snakesay("Creating web app via API"))
         if nuke:
             call_api(self.domain_url, "delete")
         response = call_api(
@@ -89,21 +103,31 @@ class Webapp:
                 "PATCH to set virtualenv path and source directory via API failed," f"got {response}:{response.text}"
             )
 
+    def create_static_file_mapping(self, url_path: str, directory_path: Path) -> None:
+        """Create a static file mapping via the API.
+
+        :param url_path: URL path (e.g., '/static/')
+        :param directory_path: Filesystem path to serve (as Path)
+
+        :raises PythonAnywhereApiException: if API call fails
+        """
+        url = f"{self.domain_url}static_files/"
+        call_api(url, "post", json=dict(url=url_path, path=str(directory_path)))
+
     def add_default_static_files_mappings(self, project_path: Path) -> None:
-        """Add default static files mappings for /static/ and /media/
+        """Add default static files mappings for /static/ and /media/.
 
         :param project_path: path to the project
+
+        :raises PythonAnywhereApiException: if API call fails
         """
-        print(snakesay("Adding static files mappings for /static/ and /media/"))
-        url = f"{self.domain_url}static_files/"
-        call_api(url, "post", json=dict(url="/static/", path=str(Path(project_path) / "static")))
-        call_api(url, "post", json=dict(url="/media/", path=str(Path(project_path) / "media")))
+        self.create_static_file_mapping("/static/", Path(project_path) / "static")
+        self.create_static_file_mapping("/media/", Path(project_path) / "media")
 
     def reload(self) -> None:
         """Reload webapp
 
         :raises PythonAnywhereApiException: if API call fails"""
-        print(snakesay(f"Reloading {self.domain} via API"))
         url = f"{self.domain_url}reload/"
         response = call_api(url, "post")
         if not response.ok:
@@ -124,10 +148,12 @@ class Webapp:
             raise PythonAnywhereApiException(f"POST to reload webapp via API failed, got {response}:{response.text}")
 
     def set_ssl(self, certificate: str, private_key: str) -> None:
-        """Set SSL certificate and private key for webapp
+        """Set SSL certificate and private key for webapp.
 
         :param certificate: SSL certificate
         :param private_key: SSL private key
+
+        :raises PythonAnywhereApiException: if API call fails
         """
         print(snakesay(f"Setting up SSL for {self.domain} via API"))
         url = f"{self.domain_url}ssl/"
@@ -144,7 +170,12 @@ class Webapp:
             )
 
     def get_ssl_info(self) -> dict[str, Any]:
-        """Get SSL certificate info"""
+        """Get SSL certificate info.
+
+        :returns: dictionary with SSL certificate information including parsed expiration date
+
+        :raises PythonAnywhereApiException: if API call fails
+        """
         url = f"{self.domain_url}ssl/"
         response = call_api(url, "get")
         if not response.ok:
@@ -181,10 +212,11 @@ class Webapp:
         if not response.ok:
             raise PythonAnywhereApiException(f"DELETE log file via API failed, got {response}:{response.text}")
 
-    def get_log_info(self) -> dict:
-        """Get log files info
+    def get_log_info(self) -> dict[str, list[int]]:
+        """Get log files info.
 
-        :returns: dictionary with log files info
+        :returns: dictionary with log files info, keys are log types ('access', 'error', 'server'), 
+                 values are lists of log file indices
 
         :raises PythonAnywhereApiException: if API call fails"""
         url = f"{self.files_url}tree/?path=/var/log/"
@@ -210,3 +242,65 @@ class Webapp:
                         continue
                     logs[log_type].append(log_index)
         return logs
+
+    @classmethod
+    def list_webapps(cls) -> list[dict[str, Any]]:
+        """List all webapps for the current user.
+
+        :returns: list of webapps info as dictionaries
+
+        :raises PythonAnywhereApiException: if API call fails
+        """
+        response = call_api(cls.webapps_url, "get")
+        if not response.ok:
+            raise PythonAnywhereApiException(
+                f"GET webapps via API failed, "
+                f"got {response}:{response.text}"
+            )
+        return response.json()
+
+    def get(self) -> dict[str, Any]:
+        """Retrieve webapp information.
+
+        :returns: dictionary with webapp information
+
+        :raises PythonAnywhereApiException: if API call fails
+        """
+        response = call_api(self.domain_url, "get")
+
+        if not response.ok:
+            raise PythonAnywhereApiException(
+                f"GET webapp for {self.domain} via API failed, got {response}:{response.text}"
+            )
+
+        return response.json()
+
+    def delete(self) -> None:
+        """Delete webapp.
+
+        :raises PythonAnywhereApiException: if API call fails
+        """
+        response = call_api(self.domain_url, "delete")
+
+        if response.status_code != 204:
+            raise PythonAnywhereApiException(
+                f"DELETE webapp for {self.domain} via API failed, got {response}:{response.text}"
+            )
+
+    def patch(self, data: dict) -> dict[str, Any]:
+        """Patch webapp with provided data.
+
+        :param data: dictionary with data to update
+        :returns: dictionary with updated webapp information
+
+        :raises PythonAnywhereApiException: if API call fails
+        """
+        response = call_api(self.domain_url, "patch", data=data)
+
+        if not response.ok:
+            raise PythonAnywhereApiException(
+                f"PATCH webapp for {self.domain} via API failed, "
+                f"got {response}:{response.text}"
+            )
+
+        return response.json()

{pythonanywhere_core-0.2.4.dist-info → pythonanywhere_core-0.2.6.dist-info}/METADATA

@@ -1,18 +1,16 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: pythonanywhere-core
-Version: 0.2.4
+Version: 0.2.6
 Summary: API wrapper for programmatic management of PythonAnywhere services.
 License: MIT
 Keywords: pythonanywhere,api,cloud,web hosting
 Author: PythonAnywhere
 Author-email: developers@pythonanywhere.com
-Requires-Python: >=3.8,<4.0
+Requires-Python: >=3.10,<4.0
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12

{pythonanywhere_core-0.2.4.dist-info → pythonanywhere_core-0.2.6.dist-info}/RECORD

@@ -1,12 +1,12 @@
-pythonanywhere_core/__init__.py,sha256=SBl2EPFW-ltPvQ7vbVWItyAsz3aKYIpjO7vcfr84GkU,22
+pythonanywhere_core/__init__.py,sha256=Oz5HbwHMyE87nmwV80AZzpkJPf-wBg7eDuJr_BXZkhU,22
 pythonanywhere_core/base.py,sha256=ro1ByvW1Wlf8Qv2d3NFnHdmM7viujmDJmxUBATqvvHI,2572
 pythonanywhere_core/exceptions.py,sha256=NT6JBtd0VK3PbFc69qx4bnAygA94-pOTghp70xxz1Xw,281
 pythonanywhere_core/files.py,sha256=qIfbcg472TPeOejpif_i64PtWP_qROlxoz5JbePzX8Q,6491
 pythonanywhere_core/schedule.py,sha256=giSO-Gssshkto9de2hSA3VeNKotXYu-lBG-iyqDolIw,3904
 pythonanywhere_core/students.py,sha256=PeBLUP7AOCRwCDiaH71wURwFx3H3PLQW91f5AjOPQmU,1778
-pythonanywhere_core/webapp.py,sha256=Oa4DTgFY3iMPsW_PqWGFb6WkMbCQz35q8VuK_-sKBKQ,8969
+pythonanywhere_core/webapp.py,sha256=x_66jfGldtQrRhPPQgGFydJnvPreFyCBEYZGqeP0Ql4,12126
 pythonanywhere_core/website.py,sha256=PZlheuqfD0_qYtcjb7fSyqq9KxphtTAXQwU0xrBKxOs,4415
-pythonanywhere_core-0.2.4.dist-info/LICENSE,sha256=zOJT_E5Fv8crFEKS5ulv0btbjnUiIkdsEBPEBmLHRlQ,1080
-pythonanywhere_core-0.2.4.dist-info/METADATA,sha256=l7aRizHVEIWWM8zDO5EOo9kCFQMLeh7z1RQrcQjNNns,1529
-pythonanywhere_core-0.2.4.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-pythonanywhere_core-0.2.4.dist-info/RECORD,,
+pythonanywhere_core-0.2.6.dist-info/LICENSE,sha256=zOJT_E5Fv8crFEKS5ulv0btbjnUiIkdsEBPEBmLHRlQ,1080
+pythonanywhere_core-0.2.6.dist-info/METADATA,sha256=wieLxN1lVBw5JMMeYTJQslxgy5-Gh1imY80s3SfZouM,1430
+pythonanywhere_core-0.2.6.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+pythonanywhere_core-0.2.6.dist-info/RECORD,,

{pythonanywhere_core-0.2.4.dist-info → pythonanywhere_core-0.2.6.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.9.0
+Generator: poetry-core 2.1.3
 Root-Is-Purelib: true
 Tag: py3-none-any