PyS3Uploader 0.2.4a1__py3-none-any.whl → 0.3.0__py3-none-any.whl

pys3uploader/__init__.py

@@ -0,0 +1,4 @@
+from pys3uploader.logger import LogHandler, LogLevel  # noqa: F401
+from pys3uploader.uploader import Uploader  # noqa: F401
+
+version = "0.3.0"

pys3uploader/logger.py

@@ -0,0 +1,100 @@
+"""Loads a default logger with StreamHandler set to DEBUG mode.
+
+>>> logging.Logger
+
+"""
+
+import logging
+import os
+from datetime import datetime
+from enum import IntEnum, StrEnum
+
+
+class LogHandler(StrEnum):
+    """Logging handlers to choose from when default logger is used.
+
+    >>> LogHandler
+
+    """
+
+    file = "file"
+    stdout = "stdout"
+
+
+class LogLevel(IntEnum):
+    """Logging levels to choose from when default logger is used.
+
+    >>> LogLevel
+
+    """
+
+    debug = logging.DEBUG
+    info = logging.INFO
+    warning = logging.WARNING
+    error = logging.ERROR
+
+    @classmethod
+    def _missing_(cls, value):
+        """Allow constructing from string names."""
+        if isinstance(value, str):
+            value = value.lower()
+            for member in cls:
+                if member.name == value:
+                    return member
+        return None
+
+
+def stream_handler() -> logging.StreamHandler:
+    """Creates a ``StreamHandler`` and assigns a default format to it.
+
+    Returns:
+        logging.StreamHandler:
+        Returns an instance of the ``StreamHandler`` object.
+    """
+    handler = logging.StreamHandler()
+    handler.setFormatter(fmt=default_format())
+    return handler
+
+
+def file_handler() -> logging.FileHandler:
+    """Creates a ``StreamHandler`` and assigns a default format to it.
+
+    Returns:
+        logging.StreamHandler:
+        Returns an instance of the ``StreamHandler`` object.
+    """
+    os.makedirs("logs", exist_ok=True)
+    filename = os.path.join("logs", datetime.now().strftime("PyS3Uploader_%d-%m-%Y_%H:%M.log"))
+    handler = logging.FileHandler(filename, mode="a")
+    handler.setFormatter(fmt=default_format())
+    return handler
+
+
+def default_format() -> logging.Formatter:
+    """Creates a logging ``Formatter`` with a custom message and datetime format.
+
+    Returns:
+        logging.Formatter:
+        Returns an instance of the ``Formatter`` object.
+    """
+    return logging.Formatter(
+        fmt="%(asctime)s - %(levelname)s - [%(module)s:%(lineno)d] - %(funcName)s - %(message)s",
+        datefmt="%b-%d-%Y %I:%M:%S %p",
+    )
+
+
+def setup_logger(handler: LogHandler, level: LogLevel):
+    """Creates a default logger with debug mode enabled.
+
+    Returns:
+        logging.Logger:
+        Returns an instance of the ``Logger`` object.
+    """
+    logger = logging.getLogger(__name__)
+    if handler == LogHandler.file:
+        logger.addHandler(hdlr=file_handler())
+    elif handler == LogHandler.stdout:
+        logger.addHandler(hdlr=stream_handler())
+
+    logger.setLevel(level)
+    return logger

{s3 → pys3uploader}/uploader.py

@@ -10,9 +10,9 @@ from botocore.config import Config
 from botocore.exceptions import ClientError
 from tqdm import tqdm
 
-from s3.exceptions import BucketNotFound
-from s3.logger import default_logger
-from s3.utils import (
+from pys3uploader.exceptions import BucketNotFound
+from pys3uploader.logger import LogHandler, LogLevel, setup_logger
+from pys3uploader.utils import (
     RETRY_CONFIG,
     UploadResults,
     convert_seconds,
@@ -45,6 +45,8 @@ class Uploader:
         aws_secret_access_key: str = None,
         retry_config: Config = RETRY_CONFIG,
         logger: logging.Logger = None,
+        log_handler: LogHandler = LogHandler.stdout,
+        log_level: LogLevel = LogLevel.debug,
         env_file: str = None,
     ):
         """Initiates all the necessary args and creates a boto3 session with retry logic.
@@ -63,6 +65,8 @@ class Uploader:
             aws_access_key_id: AWS access key ID.
             aws_secret_access_key: AWS secret access key.
             logger: Bring your own logger.
+            log_handler: Default log handler, can be ``file`` or ``stdout``.
+            log_level: Default log level, can be ``debug``, ``info``, ``warning`` or ``error``.
             env_file: Dotenv file (.env) filepath to load environment variables.
 
         See Also:
@@ -85,7 +89,7 @@ class Uploader:
                 If a filepath is provided, PyS3Uploader loads it directly or searches the root directory for the file.
                 If no filepath is provided, PyS3Uploader searches the current directory for a .env file.
         """
-        self.logger = logger or default_logger()
+        self.logger = logger or setup_logger(handler=LogHandler(log_handler), level=LogLevel(log_level))
         self.env_file = env_file or getenv("ENV_FILE", default=".env")
 
         # Check for env_file in current working directory

{pys3uploader-0.2.4a1.dist-info → pys3uploader-0.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: PyS3Uploader
-Version: 0.2.4a1
+Version: 0.3.0
 Summary: Python module to upload objects to an S3 bucket.
 Author-email: Vignesh Rao <svignesh1793@gmail.com>
 License: MIT License
@@ -29,7 +29,7 @@ Project-URL: Homepage, https://github.com/thevickypedia/PyS3Uploader
 Project-URL: Docs, https://thevickypedia.github.io/PyS3Uploader/
 Project-URL: Source, https://github.com/thevickypedia/PyS3Uploader
 Project-URL: Bug Tracker, https://github.com/thevickypedia/PyS3Uploader/issues
-Keywords: s3
+Keywords: pys3uploader
 Classifier: Development Status :: 1 - Planning
 Classifier: Intended Audience :: Information Technology
 Classifier: Operating System :: OS Independent
@@ -85,10 +85,10 @@ pip install PyS3Uploader
 
 ##### Upload objects in parallel
 ```python
-import s3
+import pys3uploader
 
 if __name__ == '__main__':
-    wrapper = s3.Uploader(
+    wrapper = pys3uploader.Uploader(
         bucket_name="BUCKET_NAME",
         upload_dir="FULL_PATH_TO_UPLOAD",
         exclude_prefix="PART_OF_UPLOAD_DIR_TO_EXCLUDE"
@@ -98,10 +98,10 @@ if __name__ == '__main__':
 
 ##### Upload objects in sequence
 ```python
-import s3
+import pys3uploader
 
 if __name__ == '__main__':
-    wrapper = s3.Uploader(
+    wrapper = pys3uploader.Uploader(
         bucket_name="BUCKET_NAME",
         upload_dir="FULL_PATH_TO_UPLOAD",
         exclude_prefix="PART_OF_UPLOAD_DIR_TO_EXCLUDE"
@@ -121,6 +121,8 @@ if __name__ == '__main__':
 - **file_exclusion** - Sequence of files to exclude during upload. Defaults to ``None``
 - **folder_exclusion** - Sequence of directories to exclude during upload. Defaults to ``None``
 - **logger** - Bring your own custom pre-configured logger. Defaults to on-screen logging.
+- **log_handler** - Choose between `stdout` vs `file` logging. Defaults to `pys3uploader.LogHandler.stdout`
+- **log_level** - Choose the logging level. Defaults to `pys3uploader.LogLevel.debug`
 - **env_file** – Path to a `.env` file for loading environment variables. Defaults to scanning the current directory.
 <br><br>
 - **region_name** - AWS region name. Defaults to the env var `AWS_DEFAULT_REGION`

pys3uploader-0.3.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+pys3uploader/__init__.py,sha256=QszR24KVfcJXbrJI0oxZCIaMs5GOtwnIbtfrY2Zj7Nk,143
+pys3uploader/exceptions.py,sha256=hH3jlMOe8yjBatQK9EdndWZz4QESU74KSY_iDhQ37SY,2585
+pys3uploader/logger.py,sha256=igwMubdTQ_GrMkwie5DAIvmxIcgj6a9UA_EGFrwFYiQ,2571
+pys3uploader/tree.py,sha256=DiQ2ekMMaj2m_P3-iKkEqSuJCJZ_UZxcAwHtAoPVa5c,1824
+pys3uploader/uploader.py,sha256=-PRwu2RvzExjLTKbw9oQuFcyNI0Uxi1IsoJu6e6wayY,14258
+pys3uploader/utils.py,sha256=NbF28CYviK_St5qd1EOumMVyus9BvQON7clUFeR_SEQ,4473
+pys3uploader-0.3.0.dist-info/LICENSE,sha256=8k-hEraOzyum0GvmmK65YxNRTFXK7eIFHJ0OshJXeTk,1068
+pys3uploader-0.3.0.dist-info/METADATA,sha256=0eS5eoAsatnmMi_wanq_kzHTZGVTvwo2c4pR_CIa3T4,8039
+pys3uploader-0.3.0.dist-info/WHEEL,sha256=beeZ86-EfXScwlR_HKu4SllMC9wUEj_8Z_4FJ3egI2w,91
+pys3uploader-0.3.0.dist-info/top_level.txt,sha256=lVIFMMoUx7dj_myetBmOUQTJiOzz5VyDqchnQElmrWw,13
+pys3uploader-0.3.0.dist-info/RECORD,,

pys3uploader-0.3.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+pys3uploader

pys3uploader-0.2.4a1.dist-info/RECORD

@@ -1,11 +0,0 @@
-s3/__init__.py,sha256=wolI_hcB1EXMCV8-uFu5Gri6ZEn_a3GZ9OgKSEBQUxA,68
-s3/exceptions.py,sha256=hH3jlMOe8yjBatQK9EdndWZz4QESU74KSY_iDhQ37SY,2585
-s3/logger.py,sha256=oH540oq8jY723jA4lDWlgfFPLbNgGXTkDwFpB7TLO_o,1196
-s3/tree.py,sha256=DiQ2ekMMaj2m_P3-iKkEqSuJCJZ_UZxcAwHtAoPVa5c,1824
-s3/uploader.py,sha256=cXH4lEyLeboKvG7TAtfyYy85BZ5y-rlROHfGqvlv0tc,13880
-s3/utils.py,sha256=NbF28CYviK_St5qd1EOumMVyus9BvQON7clUFeR_SEQ,4473
-pys3uploader-0.2.4a1.dist-info/LICENSE,sha256=8k-hEraOzyum0GvmmK65YxNRTFXK7eIFHJ0OshJXeTk,1068
-pys3uploader-0.2.4a1.dist-info/METADATA,sha256=p038fM45k9uX7A2QZkpKSypumgJsYNU13crP1Tn56qQ,7797
-pys3uploader-0.2.4a1.dist-info/WHEEL,sha256=beeZ86-EfXScwlR_HKu4SllMC9wUEj_8Z_4FJ3egI2w,91
-pys3uploader-0.2.4a1.dist-info/top_level.txt,sha256=iQp4y1P58Q633gj8M08kHE4mqqT0hixuDWcniDk_RJ4,3
-pys3uploader-0.2.4a1.dist-info/RECORD,,

pys3uploader-0.2.4a1.dist-info/top_level.txt

@@ -1 +0,0 @@
-s3

s3/__init__.py

@@ -1,3 +0,0 @@
-from s3.uploader import Uploader  # noqa: F401
-
-version = "0.2.4a1"

s3/logger.py

@@ -1,45 +0,0 @@
-"""Loads a default logger with StreamHandler set to DEBUG mode.
-
->>> logging.Logger
-
-"""
-
-import logging
-
-
-def default_handler() -> logging.StreamHandler:
-    """Creates a ``StreamHandler`` and assigns a default format to it.
-
-    Returns:
-        logging.StreamHandler:
-        Returns an instance of the ``StreamHandler`` object.
-    """
-    handler = logging.StreamHandler()
-    handler.setFormatter(fmt=default_format())
-    return handler
-
-
-def default_format() -> logging.Formatter:
-    """Creates a logging ``Formatter`` with a custom message and datetime format.
-
-    Returns:
-        logging.Formatter:
-        Returns an instance of the ``Formatter`` object.
-    """
-    return logging.Formatter(
-        fmt="%(asctime)s - %(levelname)s - [%(module)s:%(lineno)d] - %(funcName)s - %(message)s",
-        datefmt="%b-%d-%Y %I:%M:%S %p",
-    )
-
-
-def default_logger() -> logging.Logger:
-    """Creates a default logger with debug mode enabled.
-
-    Returns:
-        logging.Logger:
-        Returns an instance of the ``Logger`` object.
-    """
-    logger = logging.getLogger(__name__)
-    logger.addHandler(hdlr=default_handler())
-    logger.setLevel(level=logging.DEBUG)
-    return logger