pythonanywhere-core 0.2.8__tar.gz → 0.3.0__tar.gz

{pythonanywhere_core-0.2.8 → pythonanywhere_core-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pythonanywhere-core
-Version: 0.2.8
+Version: 0.3.0
 Summary: API wrapper for programmatic management of PythonAnywhere services.
 License: MIT
 License-File: LICENSE
@@ -20,16 +20,19 @@ Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Software Development :: Libraries
 Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
 Requires-Dist: requests (>=2.30.0,<3.0.0)
-Requires-Dist: snakesay (>=0.10.3,<0.11.0)
 Requires-Dist: typing_extensions (>=4.5.0,<5.0.0)
 Project-URL: Documentation, https://core.pythonanywhere.com/
 Project-URL: Homepage, https://core.pythonanywhere.com/
 Project-URL: Repository, https://github.com/pythonanywhere/pythonanywhere-core
 Description-Content-Type: text/x-rst
 
-API wrapper for programmatic management of PythonAnywhere services.
+pythonanywhere-core
+===================
 
-It's a core code behind `PythonAnywhere cli tool`_.
+Python SDK for PythonAnywhere API - programmatic management of PythonAnywhere
+services including webapps, files, scheduled tasks, students, and websites.
+
+Core library behind the `PythonAnywhere cli tool`_.
 
 .. _PythonAnywhere cli tool: https://pypi.org/project/pythonanywhere/
 
@@ -38,7 +41,6 @@ Documentation
 
 Full documentation is available at https://core.pythonanywhere.com/
 
-
 Development
 ===========
 

{pythonanywhere_core-0.2.8 → pythonanywhere_core-0.3.0}/README.rst

@@ -1,6 +1,10 @@
-API wrapper for programmatic management of PythonAnywhere services.
+pythonanywhere-core
+===================
 
-It's a core code behind `PythonAnywhere cli tool`_.
+Python SDK for PythonAnywhere API - programmatic management of PythonAnywhere
+services including webapps, files, scheduled tasks, students, and websites.
+
+Core library behind the `PythonAnywhere cli tool`_.
 
 .. _PythonAnywhere cli tool: https://pypi.org/project/pythonanywhere/
 
@@ -9,7 +13,6 @@ Documentation
 
 Full documentation is available at https://core.pythonanywhere.com/
 
-
 Development
 ===========
 

{pythonanywhere_core-0.2.8 → pythonanywhere_core-0.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pythonanywhere-core"
-version = "0.2.8"
+version = "0.3.0"
 description = "API wrapper for programmatic management of PythonAnywhere services."
 authors = ["PythonAnywhere <developers@pythonanywhere.com>"]
 license = "MIT"
@@ -13,6 +13,7 @@ classifiers = [
     "Intended Audience :: Developers",
     "Topic :: Software Development :: Libraries",
     "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3.14",
     "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.11",
@@ -24,11 +25,10 @@ keywords = ["pythonanywhere", "api", "cloud", "web hosting"]
 python = "^3.10"
 python-dateutil = "^2.8.2"
 requests = "^2.30.0"
-snakesay = "^0.10.3"
 typing_extensions = "^4.5.0"
 
 [tool.poetry.group.dev.dependencies]
-pytest = "^8.0.0"
+pytest = "^9.0.0"
 pytest-cov = "^7.0.0"
 pytest-mock = "^3.10.0"
 responses = "^0.25.0"

pythonanywhere_core-0.3.0/pythonanywhere_core/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.3.0"

{pythonanywhere_core-0.2.8 → pythonanywhere_core-0.3.0}/pythonanywhere_core/base.py

@@ -1,8 +1,11 @@
+import getpass
 import os
+import platform
 from typing import Dict
 
 import requests
 
+from pythonanywhere_core import __version__
 from pythonanywhere_core.exceptions import AuthenticationError, NoTokenError
 
 PYTHON_VERSIONS: Dict[str, str] = {
@@ -18,6 +21,13 @@ PYTHON_VERSIONS: Dict[str, str] = {
 }
 
 
+def get_username() -> str:
+    """Returns PythonAnywhere username from ``PYTHONANYWHERE_USERNAME``
+    environment variable, falling back to :func:`getpass.getuser`."""
+
+    return os.environ.get("PYTHONANYWHERE_USERNAME", getpass.getuser())
+
+
 def get_api_endpoint(username: str, flavor: str) -> str:
     hostname = os.environ.get(
         "PYTHONANYWHERE_SITE",
@@ -54,15 +64,35 @@ def call_api(url: str, method: str, **kwargs) -> requests.Response:
     :returns: requests.Response object
 
     :raises AuthenticationError: if API returns 401
-    :raises NoTokenError: if API_TOKEN environment variable is not set"""
+    :raises NoTokenError: if API_TOKEN environment variable is not set
+
+    Client identification can be provided via PYTHONANYWHERE_CLIENT environment
+    variable (e.g., "pa/1.0.0" or "mcp-server/0.5.0") to help with usage analytics.
+    """
 
     token = os.environ.get("API_TOKEN")
     if token is None:
         raise NoTokenError(helpful_token_error_message())
+
+    base_user_agent = f"pythonanywhere-core/{__version__}"
+    client_info = os.environ.get("PYTHONANYWHERE_CLIENT")
+
+    if client_info:
+        user_agent = f"{base_user_agent} ({client_info}; Python/{platform.python_version()})"
+    else:
+        user_agent = f"{base_user_agent} (Python/{platform.python_version()})"
+
+    headers = {
+        "Authorization": f"Token {token}",
+        "User-Agent": user_agent
+    }
+    if "headers" in kwargs:
+        headers.update(kwargs.pop("headers"))
+
     response = requests.request(
         method=method,
         url=url,
-        headers={"Authorization": f"Token {token}"},
+        headers=headers,
         **kwargs,
     )
     if response.status_code == 401:

pythonanywhere_core-0.3.0/pythonanywhere_core/exceptions.py

@@ -0,0 +1,28 @@
+class AuthenticationError(Exception):
+    pass
+
+
+class SanityException(Exception):
+    pass
+
+
+class PythonAnywhereApiException(Exception):
+    pass
+
+
+class NoTokenError(PythonAnywhereApiException):
+    pass
+
+
+class DomainAlreadyExistsException(PythonAnywhereApiException):
+    pass
+
+
+class MissingCNAMEException(PythonAnywhereApiException):
+    def __init__(self):
+        super().__init__(
+            "Could not find a CNAME for your website. If you're using an A record, "
+            "CloudFlare, or some other way of pointing your domain at PythonAnywhere "
+            "then that should not be a problem. If you're not, you should double-check "
+            "your DNS setup."
+        )

{pythonanywhere_core-0.2.8 → pythonanywhere_core-0.3.0}/pythonanywhere_core/files.py

@@ -1,10 +1,10 @@
-import getpass
+from pathlib import Path
 from typing import Tuple, Union
 from urllib.parse import urljoin
 
 from requests.models import Response
 
-from pythonanywhere_core.base import call_api, get_api_endpoint
+from pythonanywhere_core.base import call_api, get_api_endpoint, get_username
 from pythonanywhere_core.exceptions import PythonAnywhereApiException
 
 
@@ -38,7 +38,7 @@ class Files:
     """
 
 
-    base_url = get_api_endpoint(username=getpass.getuser(), flavor="files")
+    base_url = get_api_endpoint(username=get_username(), flavor="files")
     path_endpoint = urljoin(base_url, "path")
     sharing_endpoint = urljoin(base_url, "sharing/")
     tree_endpoint = urljoin(base_url, "tree/")
@@ -174,3 +174,23 @@ class Files:
             return result.json()
 
         raise PythonAnywhereApiException(f"GET to {url} failed, got {result}{self._error_msg(result)}")
+
+    def tree_post(self, local_dir_path: str, remote_dir_path: str) -> None:
+        """Uploads contents of a local directory to remote path on
+        PythonAnywhere.  Walks `local_dir_path` recursively and uploads
+        each file using :meth:`path_post`, preserving directory structure.
+
+        Raises :exc:`PythonAnywhereApiException` on first upload failure."""
+
+        local_dir = Path(local_dir_path)
+        if not local_dir.is_dir():
+            raise ValueError(f"{local_dir_path} is not a directory")
+        for path in sorted(local_dir.rglob("*")):
+            if path.is_file():
+                relative = path.relative_to(local_dir)
+                remote_path = f"{remote_dir_path}/{relative}"
+                self.path_post(remote_path, path.read_bytes())
+            elif path.is_dir() and not any(path.iterdir()):
+                placeholder = f"{remote_dir_path}/{path.relative_to(local_dir)}/.empty"
+                self.path_post(placeholder, b"")
+                self.path_delete(placeholder)

{pythonanywhere_core-0.2.8 → pythonanywhere_core-0.3.0}/pythonanywhere_core/resources.py

@@ -1,6 +1,4 @@
-import getpass
-
-from pythonanywhere_core.base import call_api, get_api_endpoint
+from pythonanywhere_core.base import call_api, get_api_endpoint, get_username
 from pythonanywhere_core.exceptions import PythonAnywhereApiException
 
 
@@ -17,7 +15,7 @@ class CPU:
     """
     
     def __init__(self):
-        self.base_url = get_api_endpoint(username=getpass.getuser(), flavor="cpu")
+        self.base_url = get_api_endpoint(username=get_username(), flavor="cpu")
 
     def get_cpu_usage(self):
         """Get current CPU usage information.

{pythonanywhere_core-0.2.8 → pythonanywhere_core-0.3.0}/pythonanywhere_core/schedule.py

@@ -1,9 +1,8 @@
-import getpass
 from typing import List, Optional
 
 from typing_extensions import Literal
 
-from pythonanywhere_core.base import call_api, get_api_endpoint
+from pythonanywhere_core.base import call_api, get_api_endpoint, get_username
 from pythonanywhere_core.exceptions import PythonAnywhereApiException
 
 
@@ -28,7 +27,7 @@ class Schedule:
         - :meth:`Schedule.update`: Update an existing task.
     """
 
-    base_url: str = get_api_endpoint(username=getpass.getuser(), flavor="schedule")
+    base_url: str = get_api_endpoint(username=get_username(), flavor="schedule")
 
     def create(self, params: dict) -> Optional[dict]:
         """Creates new scheduled task using `params`.

{pythonanywhere_core-0.2.8 → pythonanywhere_core-0.3.0}/pythonanywhere_core/students.py

@@ -1,7 +1,6 @@
-import getpass
 from typing import Optional
 
-from pythonanywhere_core.base import call_api, get_api_endpoint
+from pythonanywhere_core.base import call_api, get_api_endpoint, get_username
 
 
 class StudentsAPI:
@@ -22,7 +21,7 @@ class StudentsAPI:
         - :meth:`StudentsAPI.delete`: Remove a student.
     """
 
-    base_url: str = get_api_endpoint(username=getpass.getuser(), flavor="students")
+    base_url: str = get_api_endpoint(username=get_username(), flavor="students")
 
     def get(self) -> Optional[dict]:
         """Returns list of PythonAnywhere students related with user's account.

{pythonanywhere_core-0.2.8 → pythonanywhere_core-0.3.0}/pythonanywhere_core/webapp.py

@@ -1,16 +1,14 @@
 from __future__ import annotations
 
 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
 
-from pythonanywhere_core.base import call_api, get_api_endpoint, PYTHON_VERSIONS
-from pythonanywhere_core.exceptions import SanityException, PythonAnywhereApiException
+from pythonanywhere_core.base import call_api, get_api_endpoint, get_username, PYTHON_VERSIONS
+from pythonanywhere_core.exceptions import SanityException, PythonAnywhereApiException, MissingCNAMEException
 
 
 class Webapp:
@@ -36,7 +34,7 @@ class Webapp:
     Class Methods:
         - :meth:`Webapp.list_webapps`: List all webapps for the current user.
     """
-    username = getpass.getuser()
+    username = get_username()
     files_url = get_api_endpoint(username=username, flavor="files")
     webapps_url = get_api_endpoint(username=username, flavor="webapps")
 
@@ -54,7 +52,6 @@ class 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:
             raise SanityException(
@@ -76,11 +73,11 @@ class Webapp:
                 f"You already have a webapp for {self.domain}.\n\nUse the --nuke option if you want to replace it."
             )
 
-    def create(self, python_version: str, virtualenv_path: Path, project_path: Path, nuke: bool) -> None:
+    def create(self, python_version: str, virtualenv_path: Path | None, project_path: Path, nuke: bool) -> None:
         """Create a webapp for the given domain, using the given python version and virtualenv path
 
         :param python_version:  python version to use
-        :param virtualenv_path: path to the virtualenv
+        :param virtualenv_path: path to the virtualenv, or None to skip setting it
         :param project_path: path to the project
         :param nuke: if True, delete any existing webapp for this domain
 
@@ -127,24 +124,13 @@ class Webapp:
     def reload(self) -> None:
         """Reload webapp
 
+        :raises MissingCNAMEException: if CNAME not found (reload succeeded)
         :raises PythonAnywhereApiException: if API call fails"""
         url = f"{self.domain_url}reload/"
         response = call_api(url, "post")
         if not response.ok:
             if response.status_code == 409 and response.json()["error"] == "cname_error":
-                print(
-                    snakesay(
-                        dedent(
-                            """
-                            Could not find a CNAME for your website.  If you're using an A record,
-                            CloudFlare, or some other way of pointing your domain at PythonAnywhere
-                            then that should not be a problem.  If you're not, you should double-check
-                            your DNS setup.
-                        """
-                        )
-                    )
-                )
-                return
+                raise MissingCNAMEException()
             raise PythonAnywhereApiException(f"POST to reload webapp via API failed, got {response}:{response.text}")
 
     def set_ssl(self, certificate: str, private_key: str) -> None:
@@ -155,7 +141,6 @@ class Webapp:
 
         :raises PythonAnywhereApiException: if API call fails
         """
-        print(snakesay(f"Setting up SSL for {self.domain} via API"))
         url = f"{self.domain_url}ssl/"
         response = call_api(url, "post", json={"cert": certificate, "private_key": private_key})
         if not response.ok:
@@ -193,12 +178,6 @@ class Webapp:
 
         :raises PythonAnywhereApiException: if API call fails
         """
-        if index:
-            message = f"Deleting old (archive number {index}) {log_type} log file for {self.domain} via API"
-        else:
-            message = f"Deleting current {log_type} log file for {self.domain} via API"
-        print(snakesay(message))
-
         if index == 1:
             suffix = ".1"
         elif index > 1:

{pythonanywhere_core-0.2.8 → pythonanywhere_core-0.3.0}/pythonanywhere_core/website.py

@@ -1,7 +1,4 @@
-import getpass
-
-
-from pythonanywhere_core.base import call_api, get_api_endpoint
+from pythonanywhere_core.base import call_api, get_api_endpoint, get_username
 from pythonanywhere_core.exceptions import DomainAlreadyExistsException, PythonAnywhereApiException
 
 
@@ -24,8 +21,8 @@ class Website:
     """
 
     def __init__(self) -> None:
-        self.websites_base_url = get_api_endpoint(username=getpass.getuser(), flavor="websites")
-        self.domains_base_url = get_api_endpoint(username=getpass.getuser(), flavor="domains")
+        self.websites_base_url = get_api_endpoint(username=get_username(), flavor="websites")
+        self.domains_base_url = get_api_endpoint(username=get_username(), flavor="domains")
 
 
     def create(self, domain_name: str, command: str) -> dict:

pythonanywhere_core-0.2.8/pythonanywhere_core/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.2.8"

pythonanywhere_core-0.2.8/pythonanywhere_core/exceptions.py

@@ -1,18 +0,0 @@
-class AuthenticationError(Exception):
-    pass
-
-
-class SanityException(Exception):
-    pass
-
-
-class PythonAnywhereApiException(Exception):
-    pass
-
-
-class NoTokenError(PythonAnywhereApiException):
-    pass
-
-
-class DomainAlreadyExistsException(PythonAnywhereApiException):
-    pass