pythonanywhere-core 0.1.8__tar.gz → 0.1.10__tar.gz

{pythonanywhere_core-0.1.8 → pythonanywhere_core-0.1.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pythonanywhere-core
-Version: 0.1.8
+Version: 0.1.10
 Summary: API wrapper for programmatic management of PythonAnywhere services.
 License: MIT
 Keywords: pythonanywhere,api,cloud,web hosting
@@ -25,7 +25,30 @@ Description-Content-Type: text/x-rst
 
 API wrapper for programmatic management of PythonAnywhere services.
 
-It's an extraction and improvement of core code behind `PythonAnywhere cli tool`_.
+It's a core code behind `PythonAnywhere cli tool`_.
 
 .. _PythonAnywhere cli tool: https://pypi.org/project/pythonanywhere/
 
+
+Development
+===========
+
+To create local development environment, run:
+
+.. code-block:: shell
+
+    poetry install
+
+To run tests:
+
+.. code-block:: shell
+
+    poetry run pytest
+
+To build docs:
+
+.. code-block:: shell
+
+    cd docs
+    poetry run sphinx-build -b html . _build
+

pythonanywhere_core-0.1.10/README.rst

@@ -0,0 +1,28 @@
+API wrapper for programmatic management of PythonAnywhere services.
+
+It's a core code behind `PythonAnywhere cli tool`_.
+
+.. _PythonAnywhere cli tool: https://pypi.org/project/pythonanywhere/
+
+
+Development
+===========
+
+To create local development environment, run:
+
+.. code-block:: shell
+
+    poetry install
+
+To run tests:
+
+.. code-block:: shell
+
+    poetry run pytest
+
+To build docs:
+
+.. code-block:: shell
+
+    cd docs
+    poetry run sphinx-build -b html . _build

{pythonanywhere_core-0.1.8 → pythonanywhere_core-0.1.10}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pythonanywhere-core"
-version = "0.1.8"
+version = "0.1.10"
 description = "API wrapper for programmatic management of PythonAnywhere services."
 authors = ["PythonAnywhere <developers@pythonanywhere.com>"]
 license = "MIT"
@@ -39,3 +39,7 @@ line-length = 120
 [build-system]
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
+
+[tool.pyright]
+venvPath = "."
+venv = ".venv"

pythonanywhere_core-0.1.10/pythonanywhere_core/__init__.py

@@ -0,0 +1 @@
+__version__ = '0.1.10'

{pythonanywhere_core-0.1.8 → pythonanywhere_core-0.1.10}/pythonanywhere_core/base.py

@@ -15,12 +15,14 @@ PYTHON_VERSIONS: Dict[str, str] = {
 }
 
 
-def get_api_endpoint() -> str:
+def get_api_endpoint(username: str, flavor: str) -> str:
     hostname = os.environ.get(
         "PYTHONANYWHERE_SITE",
         "www." + os.environ.get("PYTHONANYWHERE_DOMAIN", "pythonanywhere.com"),
     )
-    return f"https://{hostname}/api/v0/user/{{username}}/{{flavor}}/"
+    if flavor == "websites":
+        return f"https://{hostname}/api/v1/user/{username}/{flavor}/"
+    return f"https://{hostname}/api/v0/user/{username}/{flavor}/"
 
 
 def helpful_token_error_message() -> str:

{pythonanywhere_core-0.1.8 → pythonanywhere_core-0.1.10}/pythonanywhere_core/files.py

@@ -41,7 +41,7 @@ class Files:
     subdirectories of a directory at `path` (limited to 1000 results)
     """
 
-    base_url = get_api_endpoint().format(username=getpass.getuser(), flavor="files")
+    base_url = get_api_endpoint(username=getpass.getuser(), flavor="files")
     path_endpoint = urljoin(base_url, "path")
     sharing_endpoint = urljoin(base_url, "sharing/")
     tree_endpoint = urljoin(base_url, "tree/")
@@ -55,6 +55,9 @@ class Files:
             return f": {msg}"
         return ""
 
+    def _make_sharing_url(self, sharing_url_suffix):
+        return urljoin(self.base_url.split("api")[0], sharing_url_suffix)
+
     def path_get(self, path: str) -> Union[dict, bytes]:
         """Returns dictionary of directory contents when `path` is an
         absolute path to of an existing directory or file contents if
@@ -113,19 +116,21 @@ class Files:
             f"DELETE on {url} failed, got {result}{self._error_msg(result)}"
         )
 
-    def sharing_post(self, path: str) -> Tuple[int, str]:
+    def sharing_post(self, path: str) -> Tuple[str, str]:
         """Starts sharing a file at `path`.
 
-        Returns a tuple with a status code and sharing link on
-        success, raises otherwise.  Status code is 201 on success, 200
-        if file has been already shared."""
+        Returns a tuple with a message and sharing link on
+        success, raises otherwise.  Message is "successfully shared" on success,
+        "was already shared" if file has been already shared."""
 
         url = self.sharing_endpoint
 
         result = call_api(url, "POST", json={"path": path})
 
         if result.ok:
-            return result.status_code, result.json()["url"]
+            msg = {200: "was already shared", 201: "successfully shared"}[result.status_code]
+            sharing_url_suffix = result.json()["url"]
+            return msg, self._make_sharing_url(sharing_url_suffix)
 
         raise PythonAnywhereApiException(
             f"POST to {url} to share '{path}' failed, got {result}{self._error_msg(result)}"
@@ -140,8 +145,11 @@ class Files:
         url = f"{self.sharing_endpoint}?path={path}"
 
         result = call_api(url, "GET")
-
-        return result.json()["url"] if result.ok else ""
+        if result.ok:
+            sharing_url_suffix = result.json()["url"]
+            return self._make_sharing_url(sharing_url_suffix)
+        else:
+            return ""
 
     def sharing_delete(self, path: str) -> int:
         """Stops sharing file at `path`.
@@ -168,4 +176,4 @@ class Files:
         if result.ok:
             return result.json()
 
-        raise PythonAnywhereApiException(f"GET to {url} failed, got {result}{self._error_msg(result)}")
+        raise PythonAnywhereApiException(f"GET to {url} failed, got {result}{self._error_msg(result)}")

{pythonanywhere_core-0.1.8 → pythonanywhere_core-0.1.10}/pythonanywhere_core/schedule.py

@@ -10,7 +10,7 @@ from pythonanywhere_core.exceptions import PythonAnywhereApiException
 class Schedule:
     """Interface for PythonAnywhere scheduled tasks API.
 
-    Uses `pythonanywhere.api` :method: `get_api_endpoint` to create url,
+    Uses `pythonanywhere_core.api` :method: `get_api_endpoint` to create url,
     which is stored in a class variable `Schedule.base_url`, then calls
     `call_api` with appropriate arguments to execute scheduled tasks tasks
     actions. Covers 'GET' and 'POST' methods for tasks list, as well as
@@ -22,7 +22,7 @@ class Schedule:
     Use :method: `Schedule.delete` to delete existing task.
     Use :method: `Schedule.update` to update existing task."""
 
-    base_url: str = get_api_endpoint().format(username=getpass.getuser(), flavor="schedule")
+    base_url: str = get_api_endpoint(username=getpass.getuser(), flavor="schedule")
 
     def create(self, params: dict) -> Optional[dict]:
         """Creates new scheduled task using `params`.

{pythonanywhere_core-0.1.8 → pythonanywhere_core-0.1.10}/pythonanywhere_core/students.py

@@ -21,7 +21,7 @@ class StudentsAPI:
     - use :method: `StudentsAPI.delete` to remove a student
     """
 
-    base_url: str = get_api_endpoint().format(username=getpass.getuser(), flavor="students")
+    base_url: str = get_api_endpoint(username=getpass.getuser(), flavor="students")
 
     def get(self) -> Optional[dict]:
         """Returns list of PythonAnywhere students related with user's account."""

{pythonanywhere_core-0.1.8 → pythonanywhere_core-0.1.10}/pythonanywhere_core/webapp.py

@@ -28,10 +28,9 @@ class Webapp:
 
     """
     def __init__(self, domain: str) -> None:
-        self.endpoint = get_api_endpoint()
         self.username = getpass.getuser()
-        self.files_url = self.endpoint.format(username=self.username, flavor="files")
-        self.webapps_url = self.endpoint.format(username=self.username, flavor="webapps")
+        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}/"
 

pythonanywhere_core-0.1.10/pythonanywhere_core/website.py

@@ -0,0 +1,82 @@
+import getpass
+
+from pythonanywhere_core.base import call_api, get_api_endpoint
+
+
+class Website:
+    """ Interface for PythonAnywhere websites API.
+
+    Uses ``pythonanywhere_core.base`` :method: ``get_api_endpoint`` to
+    create url, which is stored in a class variable ``Website.api_endpoint``,
+    then calls ``call_api`` with appropriate arguments to execute websites
+    action.
+
+    Use :method: ``Website.create`` to create new website.
+    Use :method: ``Website.get`` to get website info.
+    Use :method: ``Website.list`` to get all websites list.
+    Use :method: ``Website.reload`` to reload website.
+    Use :method: ``Website.delete`` to delete website.
+    """
+
+    api_endpoint = get_api_endpoint(username=getpass.getuser(), flavor="websites")
+
+    def create(self, domain_name: str, command: str) -> dict:
+        """Creates new website with ``domain_name`` and ``command``.
+
+        :param domain_name: domain name for new website
+        :param command: command for new website
+        :returns: dictionary with created website info"""
+
+        response = call_api(
+            self.api_endpoint,
+            "post",
+            json={
+                "domain_name": domain_name,
+                "enabled": True,
+                "webapp": {"command": command}
+            }
+        )
+        return response.json()
+
+    def get(self, domain_name: str) -> dict:
+        """Returns dictionary with website info for ``domain_name``.
+        :param domain_name:
+        :return: dictionary with website info"""
+
+        response = call_api(
+            f"{self.api_endpoint}{domain_name}/",
+            "get",
+        )
+        return response.json()
+
+    def list(self) -> list:
+        """Returns list of dictionaries with all websites info.
+        :return: list of dictionaries with websites info"""
+
+        response = call_api(
+            self.api_endpoint,
+            "get",
+        )
+        return response.json()
+
+    def reload(self, domain_name: str) -> dict:
+        """Reloads website with ``domain_name``.
+        :param domain_name: domain name for website to reload
+        :return: dictionary with response"""
+
+        response = call_api(
+            f"{self.api_endpoint}{domain_name}/reload/",
+            "post",
+        )
+        return response.json()
+
+    def delete(self, domain_name: str) -> dict:
+        """Deletes website with ``domain_name``.
+        :param domain_name: domain name for website to delete
+        :return: empty dictionary"""
+
+        call_api(
+            f"{self.api_endpoint}{domain_name}/",
+            "delete",
+        )
+        return {}

pythonanywhere_core-0.1.8/README.rst

@@ -1,5 +0,0 @@
-API wrapper for programmatic management of PythonAnywhere services.
-
-It's an extraction and improvement of core code behind `PythonAnywhere cli tool`_.
-
-.. _PythonAnywhere cli tool: https://pypi.org/project/pythonanywhere/

pythonanywhere_core-0.1.8/pythonanywhere_core/__init__.py

@@ -1 +0,0 @@
-__version__ = '0.1.8'