adds docs.

filiplajszczak · filiplajszczak · commit 052e50813270 · 2024-06-22T14:34:22.000Z
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,5 @@
 dist
+docs/_build
+.coverage
 .pytest_cache
 .venv
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/api/base.rst b/docs/api/base.rst
@@ -0,0 +1,5 @@
+Base
+====
+
+.. automodule:: base
+   :members:
diff --git a/docs/api/files.rst b/docs/api/files.rst
@@ -0,0 +1,5 @@
+Files
+=====
+
+.. automodule:: files
+   :members:
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -0,0 +1,12 @@
+Programming Interface
+=====================
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+
+   base
+   files
+   schedule
+   webapp
diff --git a/docs/api/schedule.rst b/docs/api/schedule.rst
@@ -0,0 +1,5 @@
+Scheduled Tasks
+===============
+
+.. automodule:: schedule
+   :members:
diff --git a/docs/api/webapp.rst b/docs/api/webapp.rst
@@ -0,0 +1,5 @@
+Web Apps
+========
+
+.. automodule:: webapp
+   :members:
diff --git a/docs/conf.py b/docs/conf.py
@@ -0,0 +1,31 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../pythonanywhere_core'))
+
+project = 'pythonanywhere-core'
+copyright = '2024, PythonAnywhere'
+author = 'PythonAnywhere'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ["sphinx.ext.autodoc",]
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']
diff --git a/docs/index.rst b/docs/index.rst
@@ -0,0 +1,20 @@
+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/
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+   installation
+   api/index
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -0,0 +1,4 @@
+Installation
+============
+
+``$ pip install pythonanywhere-core``
diff --git a/docs/make.bat b/docs/make.bat
@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd
diff --git a/pyproject.toml b/pyproject.toml
@@ -30,6 +30,8 @@ pytest = "^8.0.0"
 pytest-cov = "^5.0.0"
 pytest-mock = "^3.10.0"
 responses = "^0.25.0"
+sphinx = "7.1.2"
+sphinx-rtd-theme = "^2.0.0"
 
 [tool.black]
 line-length = 120
diff --git a/pythonanywhere_core/__init__.py b/pythonanywhere_core/__init__.py
@@ -1 +1 @@
-__version__ = '0.1.0'
+__version__ = '0.1.7'
diff --git a/pythonanywhere_core/base.py b/pythonanywhere_core/base.py
@@ -41,6 +41,16 @@ def helpful_token_error_message() -> str:
 
 
 def call_api(url: str, method: str, **kwargs) -> requests.Response:
+    """Calls PythonAnywhere API with given url and method.
+
+    :param url: url to call
+    :param method: HTTP method to use
+    :param kwargs: additional keyword arguments to pass to requests.request
+    :returns: requests.Response object
+
+    :raises AuthenticationError: if API returns 401
+    :raises NoTokenError: if API_TOKEN environment variable is not set"""
+
     token = os.environ.get("API_TOKEN")
     if token is None:
         raise NoTokenError(helpful_token_error_message())
diff --git a/pythonanywhere_core/webapp.py b/pythonanywhere_core/webapp.py
@@ -18,6 +18,14 @@ class Webapp:
     create url, which is stored in a class variable `Webapp.base_url`,
     then calls `call_api` with appropriate arguments to execute webapps
     action.
+
+    Use :method: `Webapp.create` to create new webapp.
+    Use :method: `Webapp.reload` to reload webapp.
+    Use :method: `Webapp.set_ssl` to set SSL certificate and private key.
+    Use :method: `Webapp.get_ssl_info` to get SSL certificate info.
+    Use :method: `Webapp.delete_log` to delete log file.
+    Use :method: `Webapp.get_log_info` to get log files info.
+
     """
     def __init__(self, domain: str) -> None:
         self.endpoint = get_api_endpoint()
@@ -31,6 +39,7 @@ def __eq__(self, other: Webapp) -> bool:
         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"""
         print(snakesay("Running API sanity checks"))
         token = os.environ.get("API_TOKEN")
         if not token:
@@ -54,6 +63,15 @@ def sanity_checks(self, nuke: bool) -> None:
             )
 
     def create(self, python_version: str, virtualenv_path: Path, 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 project_path: path to the project
+        :param nuke: if True, delete any existing webapp for this domain
+
+        :raises PythonAnywhereApiException: if API call fails
+        """
         print(snakesay("Creating web app via API"))
         if nuke:
             call_api(self.domain_url, "delete")
@@ -73,12 +91,19 @@ def create(self, python_version: str, virtualenv_path: Path, project_path: Path,
             )
 
     def add_default_static_files_mappings(self, project_path: Path) -> None:
+        """Add default static files mappings for /static/ and /media/
+
+        :param project_path: path to the project
+        """
         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")))
 
     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")
@@ -100,6 +125,11 @@ def reload(self) -> None:
             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
+
+        :param certificate: SSL certificate
+        :param private_key: SSL private key
+        """
         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})
@@ -115,6 +145,7 @@ def set_ssl(self, certificate: str, private_key: str) -> None:
             )
 
     def get_ssl_info(self) -> dict[str, Any]:
+        """Get SSL certificate info"""
         url = f"{self.domain_url}ssl/"
         response = call_api(url, "get")
         if not response.ok:
@@ -125,6 +156,13 @@ def get_ssl_info(self) -> dict[str, Any]:
         return result
 
     def delete_log(self, log_type: str, index: int = 0) -> None:
+        """Delete log file
+
+        :param log_type: log type (access, error, server)
+        :param index: log file index (0 for current, 1 for previous, etc.)
+
+        :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:
@@ -144,7 +182,12 @@ def delete_log(self, log_type: str, index: int = 0) -> None:
         if not response.ok:
             raise PythonAnywhereApiException(f"DELETE log file via API failed, got {response}:{response.text}")
 
-    def get_log_info(self):
+    def get_log_info(self) -> dict:
+        """Get log files info
+
+        :returns: dictionary with log files info
+
+        :raises PythonAnywhereApiException: if API call fails"""
         url = f"{self.files_url}tree/?path=/var/log/"
         response = call_api(url, "get")
         if not response.ok:

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +Base
 +====
++
 +.. automodule:: base
 +   :members: