Fixed workflow file to use --check for black

Author: duckduckgrayduck

.github/workflows/main.yml

@@ -53,4 +53,4 @@ jobs:
 
       - name: Run pylint and black on ./documentcloud and ./tests
         run: |
-          pylint ./documentcloud ./tests; black ./documentcloud ./tests
+          pylint ./documentcloud ./tests; black --check ./documentcloud ./tests

documentcloud/client.py

@@ -14,10 +14,12 @@
 
 logger = logging.getLogger("documentcloud")
 
+
 class DocumentCloud(SquareletClient):
     """
     The public interface for the DocumentCloud API, now integrated with SquareletClient
     """
+
     def __init__(
         self,
         username=None,
@@ -29,15 +31,15 @@ def __init__(
         rate_limit=True,
         rate_limit_sleep=True,
     ):
-       # Initialize SquareletClient for authentication and request handling
+        # 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
+            rate_limit_sleep=rate_limit_sleep,
         )
 
         # Set up logging

documentcloud/documents.py

@@ -404,9 +404,7 @@ def upload_directory(self, path, handle_errors=False, extensions=".pdf", **kwarg
         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 @@ def upload_directory(self, path, handle_errors=False, extensions=".pdf", **kwarg
                     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 @@ def upload_directory(self, path, handle_errors=False, extensions=".pdf", **kwarg
                         logger.info(
                             "Error uploading the following document: %s %s",
                             exc,
-                            file_path
+                            file_path,
                         )
                         continue
                     else:
@@ -481,7 +479,7 @@ def upload_directory(self, path, handle_errors=False, extensions=".pdf", **kwarg
                     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 @@ def upload_urls(self, url_list, handle_errors=False, **kwargs):
             # 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 @@ def upload_urls(self, url_list, handle_errors=False, **kwargs):
                     logger.info(
                         "Error creating the following documents: %s\n%s",
                         str(exc),
-                        "\n".join(url_group)
+                        "\n".join(url_group),
                     )
                     continue
                 else:

tests/test_documents.py

@@ -158,9 +158,7 @@ def test_section(self, document_factory):
 
 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 @@ def test_upload_file(self, document_factory):
             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"