python-documentcloud 4.2.0__tar.gz → 4.4.0__tar.gz

{python-documentcloud-4.2.0 → python_documentcloud-4.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: python-documentcloud
-Version: 4.2.0
+Version: 4.4.0
 Summary: A simple Python wrapper for the DocumentCloud API
 Home-page: https://github.com/muckrock/python-documentcloud
 Author: Mitchell Kotler
@@ -10,7 +10,6 @@ Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: OS Independent
 Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
@@ -27,6 +26,7 @@ Requires-Dist: requests
 Requires-Dist: urllib3
 Requires-Dist: pyyaml
 Requires-Dist: fastjsonschema
+Requires-Dist: python-squarelet
 Provides-Extra: dev
 Requires-Dist: black; extra == "dev"
 Requires-Dist: coverage; extra == "dev"
@@ -39,6 +39,16 @@ Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-mock; extra == "test"
 Requires-Dist: pytest-recording; extra == "test"
 Requires-Dist: vcrpy; extra == "test"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: summary
 
 <pre><code>  ____                                        _    ____ _                 _
  |  _ \  ___   ___ _   _ _ __ ___   ___ _ __ | |_ / ___| | ___  _   _  __| |

python_documentcloud-4.4.0/documentcloud/client.py

@@ -0,0 +1,58 @@
+# Import SquareletClient from python-squarelet
+# Standard Library
+import logging
+
+# Third Party
+from squarelet import SquareletClient
+
+# Local
+# Local Imports
+from .documents import DocumentClient
+from .organizations import OrganizationClient
+from .projects import ProjectClient
+from .users import UserClient
+
+logger = logging.getLogger("documentcloud")
+
+
+class DocumentCloud(SquareletClient):
+    """
+    The public interface for the DocumentCloud API, now integrated with SquareletClient
+    """
+
+    def __init__(
+        self,
+        username=None,
+        password=None,
+        base_uri="https://api.www.documentcloud.org/api/",
+        auth_uri="https://accounts.muckrock.com/api/",
+        timeout=20,
+        loglevel=None,
+        rate_limit=True,
+        rate_limit_sleep=True,
+    ):
+        # Initialize SquareletClient for authentication and request handling
+        super().__init__(
+            base_uri=base_uri,
+            username=username,
+            password=password,
+            auth_uri=auth_uri,
+            timeout=timeout,
+            rate_limit=rate_limit,
+            rate_limit_sleep=rate_limit_sleep,
+        )
+
+        # Set up logging
+        if loglevel:
+            logging.basicConfig(
+                level=loglevel,
+                format="%(asctime)s %(levelname)-8s %(name)-25s %(message)s",
+            )
+        else:
+            logger.addHandler(logging.NullHandler())
+
+        # Initialize the sub-clients using SquareletClient
+        self.documents = DocumentClient(self)
+        self.projects = ProjectClient(self)
+        self.users = UserClient(self)
+        self.organizations = OrganizationClient(self)

{python-documentcloud-4.2.0 → python_documentcloud-4.4.0}/documentcloud/documents.py

@@ -404,9 +404,7 @@ class DocumentClient(BaseAPIClient):
         path_list = self._collect_files(path, extensions)
 
         logger.info(
-            "Upload directory on %s: Found %d files to upload",
-            path,
-            len(path_list)
+            "Upload directory on %s: Found %d files to upload", path, len(path_list)
         )
 
         # Upload all the files using the bulk API to reduce the number
@@ -444,7 +442,7 @@ class DocumentClient(BaseAPIClient):
                     logger.info(
                         "Error creating the following documents: %s\n%s",
                         exc,
-                        "\n".join(file_paths)
+                        "\n".join(file_paths),
                     )
                     continue
                 else:
@@ -465,7 +463,7 @@ class DocumentClient(BaseAPIClient):
                         logger.info(
                             "Error uploading the following document: %s %s",
                             exc,
-                            file_path
+                            file_path,
                         )
                         continue
                     else:
@@ -481,7 +479,7 @@ class DocumentClient(BaseAPIClient):
                     logger.info(
                         "Error creating the following documents: %s\n%s",
                         exc,
-                        "\n".join(file_paths)
+                        "\n".join(file_paths),
                     )
                     continue
                 else:
@@ -504,11 +502,7 @@ class DocumentClient(BaseAPIClient):
             # Grouper will put None's on the end of the last group
             url_group = [url for url in url_group if url is not None]
 
-            logger.info(
-                "Uploading group %d: %s",
-                i + 1,
-                "\n".join(url_group)
-            )
+            logger.info("Uploading group %d: %s", i + 1, "\n".join(url_group))
 
             # Create the documents
             logger.info("Creating the documents...")
@@ -531,7 +525,7 @@ class DocumentClient(BaseAPIClient):
                     logger.info(
                         "Error creating the following documents: %s\n%s",
                         str(exc),
-                        "\n".join(url_group)
+                        "\n".join(url_group),
                     )
                     continue
                 else:

python_documentcloud-4.4.0/documentcloud/exceptions.py

@@ -0,0 +1,12 @@
+"""
+Custom exceptions for python-documentcloud
+"""
+
+# pylint: disable=unused-import
+# Import exceptions from python-squarelet
+from squarelet.exceptions import SquareletError as DocumentCloudError
+from squarelet.exceptions import DuplicateObjectError
+from squarelet.exceptions import CredentialsFailedError
+from squarelet.exceptions import APIError
+from squarelet.exceptions import DoesNotExistError
+from squarelet.exceptions import MultipleObjectsReturnedError

{python-documentcloud-4.2.0 → python_documentcloud-4.4.0}/python_documentcloud.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: python-documentcloud
-Version: 4.2.0
+Version: 4.4.0
 Summary: A simple Python wrapper for the DocumentCloud API
 Home-page: https://github.com/muckrock/python-documentcloud
 Author: Mitchell Kotler
@@ -10,7 +10,6 @@ Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: OS Independent
 Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
@@ -27,6 +26,7 @@ Requires-Dist: requests
 Requires-Dist: urllib3
 Requires-Dist: pyyaml
 Requires-Dist: fastjsonschema
+Requires-Dist: python-squarelet
 Provides-Extra: dev
 Requires-Dist: black; extra == "dev"
 Requires-Dist: coverage; extra == "dev"
@@ -39,6 +39,16 @@ Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-mock; extra == "test"
 Requires-Dist: pytest-recording; extra == "test"
 Requires-Dist: vcrpy; extra == "test"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: summary
 
 <pre><code>  ____                                        _    ____ _                 _
  |  _ \  ___   ___ _   _ _ __ ___   ___ _ __ | |_ / ___| | ___  _   _  __| |

{python-documentcloud-4.2.0 → python_documentcloud-4.4.0}/python_documentcloud.egg-info/SOURCES.txt

@@ -24,7 +24,7 @@ tests/test_annotations.py
 tests/test_base.py
 tests/test_client.py
 tests/test_documents.py
-tests/test_organizarions.py
+tests/test_organizations.py
 tests/test_projects.py
 tests/test_sections.py
 tests/test_toolbox.py

{python-documentcloud-4.2.0 → python_documentcloud-4.4.0}/python_documentcloud.egg-info/requires.txt

@@ -6,6 +6,7 @@ requests
 urllib3
 pyyaml
 fastjsonschema
+python-squarelet
 
 [dev]
 black

{python-documentcloud-4.2.0 → python_documentcloud-4.4.0}/setup.py

@@ -7,7 +7,7 @@ with open("README.md", "r") as fh:
 
 setup(
     name="python-documentcloud",
-    version="4.2.0",
+    version="4.4.0",
     description="A simple Python wrapper for the DocumentCloud API",
     author="Mitchell Kotler",
     author_email="mitch@muckrock.com",
@@ -26,6 +26,7 @@ setup(
         "urllib3",
         "pyyaml",
         "fastjsonschema",
+        "python-squarelet",
     ),
     extras_require={
         "dev": [
@@ -48,7 +49,6 @@ setup(
         "Intended Audience :: Developers",
         "Operating System :: OS Independent",
         "License :: OSI Approved :: MIT License",
-        "Programming Language :: Python :: 3.7",
         "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",

{python-documentcloud-4.2.0 → python_documentcloud-4.4.0}/tests/test_documents.py

@@ -158,9 +158,7 @@ class TestDocument:
 
 class TestDocumentClient:
     def test_search(self, client, document):
-        documents = client.documents.search(
-            f"document:{document.id} simple"
-        )
+        documents = client.documents.search(f"document:{document.id} simple")
         assert documents
 
     def test_list(self, client):
@@ -182,7 +180,6 @@ class TestDocumentClient:
             document = document_factory(pdf)
         assert document.status == "success"
 
-
     def test_upload_file_path(self, document_factory):
         document = document_factory("tests/test.pdf")
         assert document.status == "success"

python-documentcloud-4.2.0/documentcloud/client.py

@@ -1,177 +0,0 @@
-"""
-The public interface for the DocumentCloud API
-"""
-
-# Standard Library
-import logging
-from functools import partial
-from urllib.parse import parse_qs, urlparse
-
-# Third Party
-import ratelimit
-import requests
-
-# Local
-from .constants import AUTH_URI, BASE_URI, RATE_LIMIT, RATE_PERIOD, TIMEOUT
-from .documents import DocumentClient
-from .exceptions import APIError, CredentialsFailedError, DoesNotExistError
-from .organizations import OrganizationClient
-from .projects import ProjectClient
-from .toolbox import requests_retry_session
-from .users import UserClient
-
-logger = logging.getLogger("documentcloud")
-
-
-class DocumentCloud(object):
-    """
-    The public interface for the DocumentCloud API
-    """
-
-    def __init__(
-        self,
-        username=None,
-        password=None,
-        base_uri=BASE_URI,
-        auth_uri=AUTH_URI,
-        timeout=TIMEOUT,
-        loglevel=None,
-        rate_limit=True,
-        rate_limit_sleep=True,
-    ):
-        self.base_uri = base_uri
-        self.auth_uri = auth_uri
-        self.username = username
-        self.password = password
-        self._user_id = None
-        self.timeout = timeout
-        self.refresh_token = None
-        self.session = requests.Session()
-        self._set_tokens()
-
-        if loglevel:  # pragma: no cover
-            logging.basicConfig(
-                level=loglevel,
-                format="%(asctime)s %(levelname)-8s %(name)-25s %(message)s",
-            )
-        else:
-            logger.addHandler(logging.NullHandler())
-
-        self.documents = DocumentClient(self)
-        self.projects = ProjectClient(self)
-        self.users = UserClient(self)
-        self.organizations = OrganizationClient(self)
-
-        if rate_limit:
-            self._request = ratelimit.limits(calls=RATE_LIMIT, period=RATE_PERIOD)(
-                self._request
-            )
-            if rate_limit_sleep:
-                self._request = ratelimit.sleep_and_retry(self._request)
-
-    def _set_tokens(self):
-        """Set the refresh and access tokens"""
-        if self.refresh_token:
-            access_token, self.refresh_token = self._refresh_tokens(self.refresh_token)
-        elif self.username and self.password:
-            access_token, self.refresh_token = self._get_tokens(
-                self.username, self.password
-            )
-        else:
-            access_token = None
-
-        if access_token:
-            self.session.headers.update({"Authorization": f"Bearer {access_token}"})
-
-    def _get_tokens(self, username, password):
-        """Get an access and refresh token in exchange for the username and password"""
-        response = requests_retry_session().post(
-            f"{self.auth_uri}token/",
-            json={"username": username, "password": password},
-            timeout=self.timeout,
-        )
-
-        if response.status_code == requests.codes.UNAUTHORIZED:
-            raise CredentialsFailedError("The username and password are incorrect")
-
-        self.raise_for_status(response)
-
-        json = response.json()
-        return (json["access"], json["refresh"])
-
-    def _refresh_tokens(self, refresh_token):
-        """Refresh the access and refresh tokens"""
-        response = requests_retry_session().post(
-            f"{self.auth_uri}refresh/",
-            json={"refresh": refresh_token},
-            timeout=self.timeout,
-        )
-
-        if response.status_code == requests.codes.UNAUTHORIZED:
-            # refresh token is expired
-            return self._get_tokens(self.username, self.password)
-
-        self.raise_for_status(response)
-
-        json = response.json()
-        return (json["access"], json["refresh"])
-
-    @property
-    def user_id(self):
-        if self._user_id is None:
-            user = self.users.get("me")
-            self._user_id = user.id
-        return self._user_id
-
-    def _request(self, method, url, raise_error=True, **kwargs):
-        """Generic method to make API requests"""
-        # pylint: disable=method-hidden
-        logger.info("request: %s - %s - %s", method, url, kwargs)
-        set_tokens = kwargs.pop("set_tokens", True)
-        full_url = kwargs.pop("full_url", False)
-
-        if not full_url:
-            url = f"{self.base_uri}{url}"
-
-        # set the API to version 2.0
-        parsed_url = urlparse(url)
-        if "version" not in parse_qs(parsed_url.query):
-            # check to avoid double setting version
-            kwargs.setdefault("params", {}).update({"version": "2.0"})
-
-        response = requests_retry_session(session=self.session).request(
-            method, url, timeout=self.timeout, **kwargs
-        )
-        logger.debug("response: %s - %s", response.status_code, response.content)
-        if (
-            response.status_code in [requests.codes.FORBIDDEN, requests.codes.TOO_MANY]
-            and set_tokens
-        ):
-            self._set_tokens()
-            # track set_tokens to not enter an infinite loop
-            kwargs["set_tokens"] = False
-            return self._request(method, url, full_url=True, **kwargs)
-
-        if raise_error:
-            self.raise_for_status(response)
-
-        return response
-
-    def __getattr__(self, attr):
-        """Generate methods for each HTTP request type"""
-        methods = ["get", "options", "head", "post", "put", "patch", "delete"]
-        if attr in methods:
-            return partial(self._request, attr)
-        raise AttributeError(
-            f"'{self.__class__.__name__}' object has no attribute '{attr}'"
-        )
-
-    def raise_for_status(self, response):
-        """Raise for status with a custom error class"""
-        try:
-            response.raise_for_status()
-        except requests.exceptions.RequestException as exc:
-            if exc.response.status_code == 404:
-                raise DoesNotExistError(response=exc.response) from exc
-            else:
-                raise APIError(response=exc.response) from exc

python-documentcloud-4.2.0/documentcloud/exceptions.py

@@ -1,39 +0,0 @@
-"""
-Custom exceptions for python-documentcloud
-"""
-
-
-class DocumentCloudError(Exception):
-    """Base class for errors for python-documentcloud"""
-
-    def __init__(self, *args, **kwargs):
-        self.response = kwargs.pop("response", None)
-        if self.response is not None:
-            self.error = self.response.text
-            self.status_code = self.response.status_code
-            if not args:
-                args = [f"{self.status_code} - {self.error}"]
-        else:
-            self.error = None
-            self.status_code = None
-        super().__init__(*args, **kwargs)
-
-
-class DuplicateObjectError(DocumentCloudError):
-    """Raised when an object is added to a unique list more than once"""
-
-
-class CredentialsFailedError(DocumentCloudError):
-    """Raised if unable to obtain an access token due to bad login credentials"""
-
-
-class APIError(DocumentCloudError):
-    """Any other error calling the API"""
-
-
-class DoesNotExistError(APIError):
-    """Raised when the user asks the API for something it cannot find"""
-
-
-class MultipleObjectsReturnedError(APIError):
-    """Raised when the API returns multiple objects when it expected one"""