PyS3Uploader 0.0.0a0__py3-none-any.whl → 0.1.1__py3-none-any.whl

pys3uploader-0.1.1.dist-info/METADATA

@@ -0,0 +1,187 @@
+Metadata-Version: 2.2
+Name: PyS3Uploader
+Version: 0.1.1
+Summary: Python module to upload objects to an S3 bucket.
+Author-email: Vignesh Rao <svignesh1793@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2025 Vignesh Rao
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+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
+Classifier: Development Status :: 1 - Planning
+Classifier: Intended Audience :: Information Technology
+Classifier: Operating System :: OS Independent
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Internet :: File Transfer Protocol (FTP)
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: boto3==1.40.*
+Requires-Dist: tqdm==4.67.*
+Provides-Extra: dev
+Requires-Dist: sphinx==5.1.1; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: recommonmark; extra == "dev"
+
+**Versions Supported**
+
+![Python](https://img.shields.io/badge/python-3.11-blue)
+
+**Language Stats**
+
+![Language count](https://img.shields.io/github/languages/count/thevickypedia/PyS3Uploader)
+![Code coverage](https://img.shields.io/github/languages/top/thevickypedia/PyS3Uploader)
+
+**Repo Stats**
+
+[![GitHub](https://img.shields.io/github/license/thevickypedia/PyS3Uploader)][license]
+[![GitHub repo size](https://img.shields.io/github/repo-size/thevickypedia/PyS3Uploader)][repo]
+[![GitHub code size](https://img.shields.io/github/languages/code-size/thevickypedia/PyS3Uploader)][repo]
+
+**Activity**
+
+[![GitHub Repo created](https://img.shields.io/date/1618966420)][repo]
+[![GitHub commit activity](https://img.shields.io/github/commit-activity/y/thevickypedia/PyS3Uploader)][repo]
+[![GitHub last commit](https://img.shields.io/github/last-commit/thevickypedia/PyS3Uploader)][repo]
+
+**Build Status**
+
+[![pypi-publish][gha-pypi-badge]][gha-pypi]
+[![pages-build-deployment][gha-pages-badge]][gha-pages]
+
+# PyS3Uploader
+Python module to upload an entire directory to an S3 bucket.
+
+### Installation
+```shell
+pip install PyS3Uploader
+```
+
+### Usage
+
+##### Upload objects in parallel
+```python
+import s3
+
+if __name__ == '__main__':
+    wrapper = s3.Uploader(
+        bucket_name="BUCKET_NAME",
+        upload_dir="FULL_PATH_TO_UPLOAD",
+        exclude_path="PART_OF_UPLOAD_DIR_TO_EXCLUDE"
+    )
+    wrapper.run_in_parallel()
+```
+
+##### Upload objects in sequence
+```python
+import s3
+
+if __name__ == '__main__':
+    wrapper = s3.Uploader(
+        bucket_name="BUCKET_NAME",
+        upload_dir="FULL_PATH_TO_UPLOAD",
+        exclude_path="PART_OF_UPLOAD_DIR_TO_EXCLUDE"
+    )
+    wrapper.run()
+```
+
+#### Mandatory arg
+- **bucket_name** - Name of the s3 bucket.
+- **upload_dir** - Directory to upload.
+
+#### Optional kwargs
+- **s3_prefix** - S3 object prefix for each file. Defaults to ``None``
+- **exclude_path** - Path in ``upload_dir`` that has to be excluded in object keys. Defaults to `None`
+- **logger** - Bring your own custom pre-configured logger. Defaults to on-screen logging.
+<br><br>
+- **region_name** - AWS region name. Defaults to the env var `AWS_DEFAULT_REGION`
+- **profile_name** - AWS profile name. Defaults to the env var `PROFILE_NAME`
+- **aws_access_key_id** - AWS access key ID. Defaults to the env var `AWS_ACCESS_KEY_ID`
+- **aws_secret_access_key** - AWS secret access key. Defaults to the env var `AWS_SECRET_ACCESS_KEY`
+> AWS values are loaded from env vars or the default config at `~/.aws/config` / `~/.aws/credentials`
+
+### Coding Standards
+Docstring format: [`Google`](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) <br>
+Styling conventions: [`PEP 8`](https://www.python.org/dev/peps/pep-0008/) <br>
+Clean code with pre-commit hooks: [`flake8`](https://flake8.pycqa.org/en/latest/) and
+[`isort`](https://pycqa.github.io/isort/)
+
+## [Release Notes][release-notes]
+**Requirement**
+```shell
+python -m pip install gitverse
+```
+
+**Usage**
+```shell
+gitverse-release reverse -f release_notes.rst -t 'Release Notes'
+```
+
+## Linting
+`pre-commit` will ensure linting, run pytest, generate runbook & release notes, and validate hyperlinks in ALL
+markdown files (including Wiki pages)
+
+**Requirement**
+```shell
+pip install sphinx==5.1.1 pre-commit recommonmark
+```
+
+**Usage**
+```shell
+pre-commit run --all-files
+```
+
+## Pypi Package
+[![pypi-module][label-pypi-package]][pypi-repo]
+
+[https://pypi.org/project/PyS3Uploader/][pypi]
+
+## Runbook
+[![made-with-sphinx-doc][label-sphinx-doc]][sphinx]
+
+[https://thevickypedia.github.io/PyS3Uploader/][runbook]
+
+## License & copyright
+
+&copy; Vignesh Rao
+
+Licensed under the [MIT License][license]
+
+[license]: https://github.com/thevickypedia/PyS3Uploader/blob/main/LICENSE
+[release-notes]: https://github.com/thevickypedia/PyS3Uploader/blob/main/release_notes.rst
+[pypi]: https://pypi.org/project/PyS3Uploader/
+[pypi-tutorials]: https://packaging.python.org/tutorials/packaging-projects/
+[pypi-logo]: https://img.shields.io/badge/Software%20Repository-pypi-1f425f.svg
+[repo]: https://api.github.com/repos/thevickypedia/PyS3Uploader
+[gha-pages-badge]: https://github.com/thevickypedia/PyS3Uploader/actions/workflows/pages/pages-build-deployment/badge.svg
+[gha-pypi-badge]: https://github.com/thevickypedia/PyS3Uploader/actions/workflows/python-publish.yml/badge.svg
+[gha-pages]: https://github.com/thevickypedia/PyS3Uploader/actions/workflows/pages/pages-build-deployment
+[gha-pypi]: https://github.com/thevickypedia/PyS3Uploader/actions/workflows/python-publish.yml
+[sphinx]: https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html
+[label-sphinx-doc]: https://img.shields.io/badge/Made%20with-Sphinx-blue?style=for-the-badge&logo=Sphinx
+[runbook]: https://thevickypedia.github.io/PyS3Uploader/
+[label-pypi-package]: https://img.shields.io/badge/Pypi%20Package-PyS3Uploader-blue?style=for-the-badge&logo=Python
+[pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/

pys3uploader-0.1.1.dist-info/RECORD

@@ -0,0 +1,11 @@
+s3/__init__.py,sha256=XgYHKbn7gc5_nzydIKmKVjigeMtOBLqRHKHb8GJi5M4,66
+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=tQaelL7grZSWFydZOekQgVz4Fipm0PHzbt2J17ddYHs,8563
+s3/utils.py,sha256=pKVT2GbDGQKpFaHOmVrCfiQhvgr1vuSsITt_0gHguAA,687
+pys3uploader-0.1.1.dist-info/LICENSE,sha256=8k-hEraOzyum0GvmmK65YxNRTFXK7eIFHJ0OshJXeTk,1068
+pys3uploader-0.1.1.dist-info/METADATA,sha256=sW_fsQxpoZ8f8ivI0Vb4oUXt1RSlFuHJDmpP9h_CXVU,7286
+pys3uploader-0.1.1.dist-info/WHEEL,sha256=beeZ86-EfXScwlR_HKu4SllMC9wUEj_8Z_4FJ3egI2w,91
+pys3uploader-0.1.1.dist-info/top_level.txt,sha256=iQp4y1P58Q633gj8M08kHE4mqqT0hixuDWcniDk_RJ4,3
+pys3uploader-0.1.1.dist-info/RECORD,,

s3/__init__.py

@@ -1 +1,3 @@
-version = "0.0.0a0"
+from s3.uploader import Uploader  # noqa: F401
+
+version = "0.1.1"

s3/exceptions.py

@@ -0,0 +1,82 @@
+"""Module to store all the custom exceptions and formatters.
+
+>>> S3Error
+
+"""
+
+from typing import Dict, Set
+
+
+class S3Error(Exception):
+    """Custom error for base exception to the PyS3Uploader module."""
+
+
+class BucketNotFound(S3Error):
+    """Custom error for bucket not found."""
+
+
+class NoObjectFound(S3Error):
+    """Custom error for no objects found."""
+
+
+def convert_to_folder_structure(sequence: Set[str]) -> str:
+    """Convert objects in a s3 buckets into a folder like representation.
+
+    Args:
+        sequence: Takes either a mutable or immutable sequence as an argument.
+
+    Returns:
+        str:
+        String representation of the architecture.
+    """
+    folder_structure = {}
+    for item in sequence:
+        parts = item.split("/")
+        current_level = folder_structure
+        for part in parts:
+            current_level = current_level.setdefault(part, {})
+
+    def generate_folder_structure(structure: Dict[str, dict], indent: str = "") -> str:
+        """Generates the folder like structure.
+
+        Args:
+            structure: Structure of folder objects as key-value pairs.
+            indent: Required indentation for the ASCII.
+        """
+        result = ""
+        for i, (key, value) in enumerate(structure.items()):
+            if i == len(structure) - 1:
+                result += indent + "└── " + key + "\n"
+                sub_indent = indent + "    "
+            else:
+                result += indent + "├── " + key + "\n"
+                sub_indent = indent + "│   "
+            if value:
+                result += generate_folder_structure(value, sub_indent)
+        return result
+
+    return generate_folder_structure(folder_structure)
+
+
+class InvalidPrefix(S3Error):
+    """Custom exception for invalid prefix value."""
+
+    def __init__(self, prefix: str, bucket_name: str, available: Set[str]):
+        """Initialize an instance of ``InvalidPrefix`` object inherited from ``S3Error``
+
+        Args:
+            prefix: Prefix to limit the objects.
+            bucket_name: Name of the S3 bucket.
+            available: Available objects in the s3.
+        """
+        self.prefix = prefix
+        self.bucket_name = bucket_name
+        self.available = available
+        super().__init__(self.format_error_message())
+
+    def format_error_message(self):
+        """Returns the formatter error message as a string."""
+        return (
+            f"\n\n\t{self.prefix!r} was not found in {self.bucket_name}.\n\t"
+            f"Available: {self.available}\n\n{convert_to_folder_structure(self.available)}"
+        )

s3/logger.py

@@ -0,0 +1,45 @@
+"""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

s3/tree.py

@@ -0,0 +1,53 @@
+import pathlib
+from typing import List
+
+
+class Tree:
+    """Root tree formatter for a particular directory location.
+
+    This class allows the creation of a visual representation of the file
+    system hierarchy of a specified directory. It can optionally skip files
+    that start with a dot (hidden files).
+
+    >>> Tree
+
+    """
+
+    def __init__(self, skip_dot_files: bool):
+        """Instantiates the tree object.
+
+        Args:
+            skip_dot_files (bool): If True, skips files with a dot prefix (hidden files).
+        """
+        self.tree_text = []
+        self.skip_dot_files = skip_dot_files
+
+    def scan(self, path: pathlib.Path, last: bool = True, header: str = "") -> List[str]:
+        """Returns contents for a folder as a root tree.
+
+        Args:
+            path: Directory path for which the root tree is to be extracted.
+            last: Indicates if the current item is the last in the directory.
+            header: The prefix for the current level in the tree structure.
+
+        Returns:
+            List[str]:
+            A list of strings representing the directory structure.
+        """
+        elbow = "└──"
+        pipe = "│  "
+        tee = "├──"
+        blank = "   "
+        self.tree_text.append(header + (elbow if last else tee) + path.name)
+        if path.is_dir():
+            children = list(path.iterdir())
+            for idx, child in enumerate(children):
+                # Skip child file/directory when dot files are supposed to be hidden
+                if self.skip_dot_files and child.name.startswith("."):
+                    continue
+                self.scan(
+                    child,
+                    header=header + (blank if last else pipe),
+                    last=idx == len(children) - 1,
+                )
+        return self.tree_text

s3/uploader.py

@@ -0,0 +1,202 @@
+import logging
+import os
+import time
+from concurrent.futures import ThreadPoolExecutor, as_completed
+from typing import Dict
+
+import boto3.resources.factory
+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 UploadResults, getenv, urljoin
+
+
+class Uploader:
+    """Initiates Uploader object to upload entire directory to S3.
+
+    >>> Uploader
+
+    """
+
+    RETRY_CONFIG: Config = Config(retries={"max_attempts": 10, "mode": "standard"})
+
+    def __init__(
+        self,
+        bucket_name: str,
+        upload_dir: str,
+        s3_prefix: str = None,
+        exclude_path: str = None,
+        region_name: str = None,
+        profile_name: str = None,
+        aws_access_key_id: str = None,
+        aws_secret_access_key: str = None,
+        logger: logging.Logger = None,
+    ):
+        """Initiates all the necessary args and creates a boto3 session with retry logic.
+
+        Args:
+            bucket_name: Name of the bucket.
+            upload_dir: Full path of the directory to be uploaded.
+            s3_prefix: Particular bucket prefix within which the upload should happen.
+            exclude_path: Full directory path to exclude from S3 object prefix.
+            region_name: Name of the AWS region.
+            profile_name: AWS profile name.
+            aws_access_key_id: AWS access key ID.
+            aws_secret_access_key: AWS secret access key.
+            logger: Bring your own logger.
+
+        See Also:
+            exclude_path:
+                When upload directory is "/home/ubuntu/Desktop/S3Upload", each file will naturally have the full prefix.
+                However, this behavior can be avoided by specifying the ``exclude_path`` parameter.
+
+                If exclude_path is set to: ``/home/ubuntu/Desktop``, then the file path
+                ``/home/ubuntu/Desktop/S3Upload/sub-dir/photo.jpg`` will be uploaded as ``S3Upload/sub-dir/photo.jpg``
+
+            s3_prefix:
+                If provided, ``s3_prefix`` will always be attached to each object.
+
+                If ``s3_prefix`` is set to: ``2025``, then the file path
+                ``/home/ubuntu/Desktop/S3Upload/sub/photo.jpg`` will be uploaded as ``2025/S3Upload/sub/photo.jpg``
+        """
+        self.session = boto3.Session(
+            profile_name=profile_name or getenv("PROFILE_NAME"),
+            region_name=region_name or getenv("AWS_DEFAULT_REGION"),
+            aws_access_key_id=aws_access_key_id or getenv("AWS_ACCESS_KEY_ID"),
+            aws_secret_access_key=aws_secret_access_key or getenv("AWS_SECRET_ACCESS_KEY"),
+        )
+        self.s3 = self.session.resource(service_name="s3", config=self.RETRY_CONFIG)
+        self.logger = logger or default_logger()
+        self.upload_dir = upload_dir or getenv("UPLOAD_DIR", "UPLOAD_SOURCE")
+        self.s3_prefix = s3_prefix
+        self.exclude_path = exclude_path
+        self.bucket_name = bucket_name
+        # noinspection PyUnresolvedReferences
+        self.bucket: boto3.resources.factory.s3.Bucket = None
+        self.results = UploadResults()
+        self.start = time.time()
+
+    def init(self) -> None:
+        """Instantiates the bucket instance.
+
+        Raises:
+            ValueError: If no bucket name was passed.
+            BucketNotFound: If bucket name was not found.
+        """
+        self.start = time.time()
+        if self.exclude_path and self.exclude_path not in self.upload_dir:
+            raise ValueError(
+                f"\n\n\tStart folder {self.exclude_path!r} is not a part of upload directory {self.upload_dir!r}"
+            )
+        if not self.upload_dir:
+            raise ValueError("\n\n\tCannot proceed without an upload directory.")
+        try:
+            assert os.path.exists(self.upload_dir)
+        except AssertionError:
+            raise ValueError(f"\n\n\tPath not found: {self.upload_dir}")
+        buckets = [bucket.name for bucket in self.s3.buckets.all()]
+        if not self.bucket_name:
+            raise ValueError(f"\n\n\tCannot proceed without a bucket name.\n\tAvailable: {buckets}")
+        _account_id, _alias = self.session.resource(service_name="iam").CurrentUser().arn.split("/")
+        if self.bucket_name not in buckets:
+            raise BucketNotFound(f"\n\n\t{self.bucket_name} was not found in {_alias} account.\n\tAvailable: {buckets}")
+        self.upload_dir = os.path.abspath(self.upload_dir)
+        # noinspection PyUnresolvedReferences
+        self.bucket: boto3.resources.factory.s3.Bucket = self.s3.Bucket(self.bucket_name)
+
+    def exit(self) -> None:
+        """Exits after printing results, and run time."""
+        total = self.results.success + self.results.failed
+        self.logger.info(
+            "Total number of uploads: %d, success: %d, failed: %d", total, self.results.success, self.results.failed
+        )
+        self.logger.info("Run Time: %.2fs", time.time() - self.start)
+
+    def _uploader(self, objectpath: str, filepath: str) -> None:
+        """Uploads the filepath to the specified S3 bucket.
+
+        Args:
+            objectpath: Object path ref in S3.
+            filepath: Filepath to upload.
+        """
+        self.bucket.upload_file(filepath, objectpath)
+
+    def _get_files(self) -> Dict[str, str]:
+        """Get a mapping for all the file path and object paths in upload directory.
+
+        Returns:
+            Dict[str, str]:
+            Returns a dictionary object path and filepath.
+        """
+        files_to_upload = {}
+        for __path, __directory, __files in os.walk(self.upload_dir):
+            for file_ in __files:
+                file_path = os.path.join(__path, file_)
+                if self.exclude_path:
+                    file_path = file_path.replace(self.exclude_path, "")
+                # Lists in python are ordered, so s3 prefix will get loaded first when provided
+                url_parts = []
+                if self.s3_prefix:
+                    url_parts.extend(
+                        self.s3_prefix.split(os.sep) if os.sep in self.s3_prefix else self.s3_prefix.split("/")
+                    )
+                # Add rest of the file path to parts before normalizing as an S3 object URL
+                url_parts.extend(file_path.split(os.sep))
+                # Remove falsy values using filter - "None", "bool", "len" or "lambda item: item"
+                object_path = urljoin(*filter(None, url_parts))
+                files_to_upload[object_path] = file_path
+        return files_to_upload
+
+    def run(self) -> None:
+        """Initiates object upload in a traditional loop."""
+        self.init()
+        keys = self._get_files()
+        self.logger.debug(keys)
+        self.logger.info("%d files from '%s' will be uploaded to '%s'", len(keys), self.upload_dir, self.bucket_name)
+        self.logger.info("Initiating upload process.")
+        for objectpath, filepath in tqdm(
+            keys.items(), total=len(keys), unit="file", leave=True, desc=f"Uploading files from {self.upload_dir}"
+        ):
+            try:
+                self._uploader(objectpath=objectpath, filepath=filepath)
+                self.results.success += 1
+            except ClientError as error:
+                self.logger.error(error)
+                self.results.failed += 1
+        self.exit()
+
+    def run_in_parallel(self, max_workers: int = 5) -> None:
+        """Initiates upload in multi-threading.
+
+        Args:
+            max_workers: Number of maximum threads to use.
+        """
+        self.init()
+        keys = self._get_files()
+        self.logger.debug(keys)
+        self.logger.info(
+            "%d files from '%s' will be uploaded to '%s' with maximum concurrency of: %d",
+            len(keys),
+            self.upload_dir,
+            self.bucket_name,
+            max_workers,
+        )
+        with ThreadPoolExecutor(max_workers=max_workers) as executor:
+            futures = [executor.submit(self._uploader, *kv) for kv in keys.items()]
+            for future in tqdm(
+                iterable=as_completed(futures),
+                total=len(futures),
+                desc=f"Uploading files to {self.bucket_name}",
+                unit="files",
+                leave=True,
+            ):
+                try:
+                    future.result()
+                    self.results.success += 1
+                except ClientError as error:
+                    self.logger.error(f"Upload failed: {error}")
+                    self.results.failed += 1
+        self.exit()

s3/utils.py

@@ -0,0 +1,30 @@
+import os
+
+
+class UploadResults(dict):
+    """Object to store results of S3 upload.
+
+    >>> UploadResults
+
+    """
+
+    success: int = 0
+    failed: int = 0
+
+
+def getenv(*args, default: str = None) -> str:
+    """Returns the key-ed environment variable or the default value."""
+    for key in args:
+        if value := os.environ.get(key.upper()) or os.environ.get(key.lower()):
+            return value
+    return default
+
+
+def urljoin(*args) -> str:
+    """Joins given arguments into a url. Trailing but not leading slashes are stripped for each argument.
+
+    Returns:
+        str:
+        Joined url.
+    """
+    return "/".join(map(lambda x: str(x).rstrip("/").lstrip("/"), args))

pys3uploader-0.0.0a0.dist-info/METADATA

@@ -1,49 +0,0 @@
-Metadata-Version: 2.2
-Name: PyS3Uploader
-Version: 0.0.0a0
-Summary: Python module to upload objects to an S3 bucket.
-Author-email: Vignesh Rao <svignesh1793@gmail.com>
-License: MIT License
-        
-        Copyright (c) 2025 Vignesh Rao
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-        SOFTWARE.
-        
-Project-URL: Homepage, https://github.com/thevickypedia/s3-uploader
-Project-URL: Docs, https://thevickypedia.github.io/s3-uploader/
-Project-URL: Source, https://github.com/thevickypedia/s3-uploader
-Project-URL: Bug Tracker, https://github.com/thevickypedia/s3-uploader/issues
-Keywords: s3
-Classifier: Development Status :: 1 - Planning
-Classifier: Intended Audience :: Information Technology
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Topic :: Internet :: File Transfer Protocol (FTP)
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: boto3
-Requires-Dist: tqdm
-Provides-Extra: dev
-Requires-Dist: sphinx==5.1.1; extra == "dev"
-Requires-Dist: pre-commit; extra == "dev"
-Requires-Dist: recommonmark; extra == "dev"
-
-# s3-uploader
-Upload objects to S3

pys3uploader-0.0.0a0.dist-info/RECORD

@@ -1,6 +0,0 @@
-s3/__init__.py,sha256=wq6ADf1YC8sccYtXrSjPGhw7W-AHqruT82iKIaMcttM,20
-pys3uploader-0.0.0a0.dist-info/LICENSE,sha256=8k-hEraOzyum0GvmmK65YxNRTFXK7eIFHJ0OshJXeTk,1068
-pys3uploader-0.0.0a0.dist-info/METADATA,sha256=nWmw-uD4ok-IyS1eXHgjINPF6DKO3cJ4xSqgGzg_f_8,2277
-pys3uploader-0.0.0a0.dist-info/WHEEL,sha256=beeZ86-EfXScwlR_HKu4SllMC9wUEj_8Z_4FJ3egI2w,91
-pys3uploader-0.0.0a0.dist-info/top_level.txt,sha256=iQp4y1P58Q633gj8M08kHE4mqqT0hixuDWcniDk_RJ4,3
-pys3uploader-0.0.0a0.dist-info/RECORD,,