Merge pull request #44 from GitGuardian/plalanne/43/fix-dependencies

Fix missing dependencies in the package

Author: agateau-gg

Pipfile

@@ -4,10 +4,7 @@ url = "https://pypi.python.org/simple"
 verify_ssl = true
 
 [packages]
-marshmallow = ">=3.5"
 pygitguardian = { editable = true, path = "." }
-requests = ">=2"
-marshmallow-dataclass = ">=8.5.8,<8.6.0"
 
 [dev-packages]
 black = "==22.3.0"

pygitguardian/__init__.py

@@ -1,10 +1,8 @@
 """PyGitGuardian API Client"""
-from .client import GGClient
+from .client import ContentTooLarge, GGClient
 
 
 __version__ = "1.5.0"
 GGClient._version = __version__
 
-__all__ = [
-    "GGClient",
-]
+__all__ = ["GGClient", "ContentTooLarge"]

pygitguardian/client.py

@@ -6,7 +6,6 @@
 from pathlib import Path
 from typing import Any, Dict, List, Optional, Union, cast
 
-import click
 import requests
 from requests import Response, Session, codes
 
@@ -36,6 +35,14 @@
 MAX_TAR_CONTENT_SIZE = 30 * 1024 * 1024
 
 
+class ContentTooLarge(Exception):
+    """
+    Raised if the total size of files sent by the client exceeds MAX_TAR_CONTENT_SIZE
+    """
+
+    pass
+
+
 class Versions:
     app_version: Optional[str] = None
     secrets_engine_version: Optional[str] = None
@@ -86,7 +93,7 @@ def _create_tar(root_path: Path, filenames: List[str]) -> bytes:
             full_path = root_path / filename
             current_dir_size += os.path.getsize(full_path)
             if current_dir_size > MAX_TAR_CONTENT_SIZE:
-                raise click.ClickException(
+                raise ContentTooLarge(
                     f"The total size of the files processed exceeds {MAX_TAR_CONTENT_SIZE / (1024 * 1024):.0f}MB, "
                     f"please try again with less files"
                 )
@@ -393,7 +400,6 @@ def iac_directory_scan(
         scan_parameters: IaCScanParameters,
         extra_headers: Optional[Dict[str, str]] = None,
     ) -> Union[Detail, IaCScanResult]:
-
         tar = _create_tar(directory, filenames)
         result: Union[Detail, IaCScanResult]
         try:

setup.py

@@ -24,14 +24,19 @@ def get_version() -> str:
     name="pygitguardian",
     version=get_version(),
     packages=find_packages(exclude=["tests"]),
-    description="Python Wrapper for GitGuardian's API -- Scan security policy breaks everywhere",
+    description="Python Wrapper for GitGuardian's API -- Scan security "
+    "policy breaks everywhere",
     long_description=read("README.md"),
     long_description_content_type="text/markdown",
     url="https://github.com/GitGuardian/py-gitguardian",
     author="GitGuardian",
     author_email="[email protected]",
     maintainer="GitGuardian",
-    install_requires=["marshmallow>=3.5", "requests>=2"],
+    install_requires=[
+        "marshmallow>=3.5, <4",
+        "requests>=2, <3",
+        "marshmallow-dataclass >=8.5.8, <8.6.0",
+    ],
     include_package_data=True,
     zip_safe=True,
     license="MIT",

tests/test_utils.py

@@ -2,10 +2,9 @@
 from io import BytesIO
 from unittest import mock
 
-import click
 import pytest
 
-from pygitguardian.client import _create_tar
+from pygitguardian.client import ContentTooLarge, _create_tar
 
 
 def test_create_tar(tmp_path):
@@ -44,7 +43,7 @@ def test_create_tar_cannot_exceed_max_tar_content_size(tmp_path):
         (tmp_path / file2_name).write_text("")
 
         with pytest.raises(
-            click.ClickException,
+            ContentTooLarge,
             match=r"The total size of the files processed exceeds \d+MB, please try again with less files",
         ):
             _create_tar(tmp_path, [file1_name, file2_name])