bifrostsdk 1.0.0__tar.gz

bifrostsdk-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Ifihanagbara Olusheye
+
+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.

bifrostsdk-1.0.0/PKG-INFO

@@ -0,0 +1,124 @@
+Metadata-Version: 2.1
+Name: bifrostsdk
+Version: 1.0.0
+Summary: Rainbow Bridge for shipping your files to any cloud storage service with the same function calls
+Author-email: ifihan <victoriaolusheye@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/Ifihan/byfrost
+Project-URL: Bug Tracker, https://github.com/Ifihan/byfrost/issues
+Project-URL: Documentation, https://github.com/Ifihan/byfrost/blob/main/README.md
+Project-URL: Source Code, https://github.com/Ifihan/byfrost
+Keywords: cloud,storage,gcs,s3,pinata,upload,aws,google-cloud,bifrost
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Internet
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: google-cloud-storage>=2.5.0
+Requires-Dist: boto3>=1.34.0
+Requires-Dist: requests>=2.25.0
+Requires-Dist: requests-toolbelt>=1.0.0
+
+# Bifrost
+
+Rainbow Bridge for shipping your files to any cloud storage service with the same function calls.
+
+<img src="https://user-images.githubusercontent.com/59074379/226159115-1cfcb221-127f-4574-87ed-b74b4b2c4591.png" width="1000" />
+
+# Table of contents
+
+- [Bifrost](#bifrost)
+- [Problem Statement](#problem-statement)
+  - [Google Cloud Storage using GCS SDK](#google-cloud-storage-using-gcs-sdk)
+  - [Pinata Cloud using Pinata API](#pinata-cloud-using-pinata-api)
+  - [Using Bifrost](#using-bifrost)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Contributing](#contributing)
+- [License](#license)
+- [Changelog](#changelog)
+- [Contributors](#contributors)
+
+# Problem Statement
+
+Many projects need to store files in the cloud and different projects might use different cloud storage providers or, sometimes, multiple cloud providers all at once. Using different SDKs with different implementations for each provider can be tedious and time-consuming. Bifrost aims to simplify the process of working with multiple cloud storage providers by providing a consistent API for all of them.
+
+To gain a better understanding of how Bifrost addresses this issue, let's take you on a ride with Thor by comparing two different code samples for working with Google Cloud Storage and Pinata Cloud in a single project: one using a conventional approach and the other using Bifrost.
+
+## Google Cloud Storage using GCS SDK
+
+Without Bifrost, the process of uploading a file to GCS using the Google Cloud Storage client library for Python would typically involve the following steps:
+
+```py
+# to be added
+```
+
+## Pinata Cloud using Pinata API
+
+...and for Pinata Cloud, the usual way of uploading a file in Python would be something along the following steps:
+
+```py
+# to be added
+```
+
+We can already see the challenges of the conventional methods since they require you to learn to use multiple packages with separate implementation patterns. Now this is why `Bifrost` comes in! With Bifrost, you can mount rainbow bridges to the providers you want and use the same set of functions to upload files through any of these mounted bridges. This makes it much easier to work with multiple providers and streamlines the development process to just one learning curve.
+
+Now, let's see how we can revamp the two samples above into something much more exciting with Bifrost.
+
+## Using Bifrost
+
+```py
+# to be added
+```
+
+The above example clearly demonstrates the speed, simplicity, and ease of use that Bifrost offers. Now you know what it feels like to ride with Thor!
+
+# Installation
+
+```bash
+pip install byfrost
+```
+
+# Usage
+
+If you want to learn more about how Bifrost is creating different methods to make it easier to use different cloud providers, you can follow these links:
+
+- [Google Cloud Storage (GCS)](gcs\doc.md)
+- [Amazon S3](s3\doc.md)
+- [Pinata Cloud](pinata\doc.md)
+
+# Variants
+
+Bifrost also exists in other forms and languages and you are free to start a new variant of bifrost in any other form or language of your choice. For now, below are the know variants of bifrost.
+
+- [x] [Bifrost in Golang](https://github.com/opensaucerer/bifrost)
+- [x] [Bifrost CLI](https://github.com/showbaba/bifrost-cli)
+
+# Contributing
+
+Bifrost is an open source project and we welcome contributions of all kinds. Please read our [contributing guide](./contributing.md) to learn about our development process, how to propose bug fixes and improvements, and how to build and test your changes to Bifrost.
+
+# License
+
+Bifrost is [MIT licensed](./LICENSE).
+
+# Changelog
+
+See [changelog](./changelog.md) for more details.
+
+# Contributors
+
+<a href="https://github.com/ifihan/byfrost/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=ifihan/byfrost" />
+</a>
+
+Made with [contrib.rocks](https://contrib.rocks).

bifrostsdk-1.0.0/README.md

@@ -0,0 +1,94 @@
+# Bifrost
+
+Rainbow Bridge for shipping your files to any cloud storage service with the same function calls.
+
+<img src="https://user-images.githubusercontent.com/59074379/226159115-1cfcb221-127f-4574-87ed-b74b4b2c4591.png" width="1000" />
+
+# Table of contents
+
+- [Bifrost](#bifrost)
+- [Problem Statement](#problem-statement)
+  - [Google Cloud Storage using GCS SDK](#google-cloud-storage-using-gcs-sdk)
+  - [Pinata Cloud using Pinata API](#pinata-cloud-using-pinata-api)
+  - [Using Bifrost](#using-bifrost)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Contributing](#contributing)
+- [License](#license)
+- [Changelog](#changelog)
+- [Contributors](#contributors)
+
+# Problem Statement
+
+Many projects need to store files in the cloud and different projects might use different cloud storage providers or, sometimes, multiple cloud providers all at once. Using different SDKs with different implementations for each provider can be tedious and time-consuming. Bifrost aims to simplify the process of working with multiple cloud storage providers by providing a consistent API for all of them.
+
+To gain a better understanding of how Bifrost addresses this issue, let's take you on a ride with Thor by comparing two different code samples for working with Google Cloud Storage and Pinata Cloud in a single project: one using a conventional approach and the other using Bifrost.
+
+## Google Cloud Storage using GCS SDK
+
+Without Bifrost, the process of uploading a file to GCS using the Google Cloud Storage client library for Python would typically involve the following steps:
+
+```py
+# to be added
+```
+
+## Pinata Cloud using Pinata API
+
+...and for Pinata Cloud, the usual way of uploading a file in Python would be something along the following steps:
+
+```py
+# to be added
+```
+
+We can already see the challenges of the conventional methods since they require you to learn to use multiple packages with separate implementation patterns. Now this is why `Bifrost` comes in! With Bifrost, you can mount rainbow bridges to the providers you want and use the same set of functions to upload files through any of these mounted bridges. This makes it much easier to work with multiple providers and streamlines the development process to just one learning curve.
+
+Now, let's see how we can revamp the two samples above into something much more exciting with Bifrost.
+
+## Using Bifrost
+
+```py
+# to be added
+```
+
+The above example clearly demonstrates the speed, simplicity, and ease of use that Bifrost offers. Now you know what it feels like to ride with Thor!
+
+# Installation
+
+```bash
+pip install byfrost
+```
+
+# Usage
+
+If you want to learn more about how Bifrost is creating different methods to make it easier to use different cloud providers, you can follow these links:
+
+- [Google Cloud Storage (GCS)](gcs\doc.md)
+- [Amazon S3](s3\doc.md)
+- [Pinata Cloud](pinata\doc.md)
+
+# Variants
+
+Bifrost also exists in other forms and languages and you are free to start a new variant of bifrost in any other form or language of your choice. For now, below are the know variants of bifrost.
+
+- [x] [Bifrost in Golang](https://github.com/opensaucerer/bifrost)
+- [x] [Bifrost CLI](https://github.com/showbaba/bifrost-cli)
+
+# Contributing
+
+Bifrost is an open source project and we welcome contributions of all kinds. Please read our [contributing guide](./contributing.md) to learn about our development process, how to propose bug fixes and improvements, and how to build and test your changes to Bifrost.
+
+# License
+
+Bifrost is [MIT licensed](./LICENSE).
+
+# Changelog
+
+See [changelog](./changelog.md) for more details.
+
+# Contributors
+
+<a href="https://github.com/ifihan/byfrost/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=ifihan/byfrost" />
+</a>
+
+Made with [contrib.rocks](https://contrib.rocks).

bifrostsdk-1.0.0/bifrostsdk.egg-info/PKG-INFO

@@ -0,0 +1,124 @@
+Metadata-Version: 2.1
+Name: bifrostsdk
+Version: 1.0.0
+Summary: Rainbow Bridge for shipping your files to any cloud storage service with the same function calls
+Author-email: ifihan <victoriaolusheye@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/Ifihan/byfrost
+Project-URL: Bug Tracker, https://github.com/Ifihan/byfrost/issues
+Project-URL: Documentation, https://github.com/Ifihan/byfrost/blob/main/README.md
+Project-URL: Source Code, https://github.com/Ifihan/byfrost
+Keywords: cloud,storage,gcs,s3,pinata,upload,aws,google-cloud,bifrost
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Internet
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: google-cloud-storage>=2.5.0
+Requires-Dist: boto3>=1.34.0
+Requires-Dist: requests>=2.25.0
+Requires-Dist: requests-toolbelt>=1.0.0
+
+# Bifrost
+
+Rainbow Bridge for shipping your files to any cloud storage service with the same function calls.
+
+<img src="https://user-images.githubusercontent.com/59074379/226159115-1cfcb221-127f-4574-87ed-b74b4b2c4591.png" width="1000" />
+
+# Table of contents
+
+- [Bifrost](#bifrost)
+- [Problem Statement](#problem-statement)
+  - [Google Cloud Storage using GCS SDK](#google-cloud-storage-using-gcs-sdk)
+  - [Pinata Cloud using Pinata API](#pinata-cloud-using-pinata-api)
+  - [Using Bifrost](#using-bifrost)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Contributing](#contributing)
+- [License](#license)
+- [Changelog](#changelog)
+- [Contributors](#contributors)
+
+# Problem Statement
+
+Many projects need to store files in the cloud and different projects might use different cloud storage providers or, sometimes, multiple cloud providers all at once. Using different SDKs with different implementations for each provider can be tedious and time-consuming. Bifrost aims to simplify the process of working with multiple cloud storage providers by providing a consistent API for all of them.
+
+To gain a better understanding of how Bifrost addresses this issue, let's take you on a ride with Thor by comparing two different code samples for working with Google Cloud Storage and Pinata Cloud in a single project: one using a conventional approach and the other using Bifrost.
+
+## Google Cloud Storage using GCS SDK
+
+Without Bifrost, the process of uploading a file to GCS using the Google Cloud Storage client library for Python would typically involve the following steps:
+
+```py
+# to be added
+```
+
+## Pinata Cloud using Pinata API
+
+...and for Pinata Cloud, the usual way of uploading a file in Python would be something along the following steps:
+
+```py
+# to be added
+```
+
+We can already see the challenges of the conventional methods since they require you to learn to use multiple packages with separate implementation patterns. Now this is why `Bifrost` comes in! With Bifrost, you can mount rainbow bridges to the providers you want and use the same set of functions to upload files through any of these mounted bridges. This makes it much easier to work with multiple providers and streamlines the development process to just one learning curve.
+
+Now, let's see how we can revamp the two samples above into something much more exciting with Bifrost.
+
+## Using Bifrost
+
+```py
+# to be added
+```
+
+The above example clearly demonstrates the speed, simplicity, and ease of use that Bifrost offers. Now you know what it feels like to ride with Thor!
+
+# Installation
+
+```bash
+pip install byfrost
+```
+
+# Usage
+
+If you want to learn more about how Bifrost is creating different methods to make it easier to use different cloud providers, you can follow these links:
+
+- [Google Cloud Storage (GCS)](gcs\doc.md)
+- [Amazon S3](s3\doc.md)
+- [Pinata Cloud](pinata\doc.md)
+
+# Variants
+
+Bifrost also exists in other forms and languages and you are free to start a new variant of bifrost in any other form or language of your choice. For now, below are the know variants of bifrost.
+
+- [x] [Bifrost in Golang](https://github.com/opensaucerer/bifrost)
+- [x] [Bifrost CLI](https://github.com/showbaba/bifrost-cli)
+
+# Contributing
+
+Bifrost is an open source project and we welcome contributions of all kinds. Please read our [contributing guide](./contributing.md) to learn about our development process, how to propose bug fixes and improvements, and how to build and test your changes to Bifrost.
+
+# License
+
+Bifrost is [MIT licensed](./LICENSE).
+
+# Changelog
+
+See [changelog](./changelog.md) for more details.
+
+# Contributors
+
+<a href="https://github.com/ifihan/byfrost/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=ifihan/byfrost" />
+</a>
+
+Made with [contrib.rocks](https://contrib.rocks).

bifrostsdk-1.0.0/bifrostsdk.egg-info/SOURCES.txt

@@ -0,0 +1,54 @@
+LICENSE
+README.md
+pyproject.toml
+bifrostsdk.egg-info/PKG-INFO
+bifrostsdk.egg-info/SOURCES.txt
+bifrostsdk.egg-info/dependency_links.txt
+bifrostsdk.egg-info/requires.txt
+bifrostsdk.egg-info/top_level.txt
+byfrost/__init__.py
+byfrost/__init__.pyi
+byfrost/bifrost.py
+byfrost/bifrost.pyi
+byfrost/gcs/__init__.py
+byfrost/gcs/__init__.pyi
+byfrost/gcs/gcs.py
+byfrost/gcs/gcs.pyi
+byfrost/pinata/__init__.py
+byfrost/pinata/__init__.pyi
+byfrost/pinata/pinata.py
+byfrost/pinata/pinata.pyi
+byfrost/s3/__init__.py
+byfrost/s3/__init__.pyi
+byfrost/s3/s3.py
+byfrost/s3/s3.pyi
+byfrost/shared/__init__.py
+byfrost/shared/config/__init__.py
+byfrost/shared/config/__init__.pyi
+byfrost/shared/config/option.py
+byfrost/shared/config/provider.py
+byfrost/shared/config/request.py
+byfrost/shared/config/url.py
+byfrost/shared/errors/__init__.py
+byfrost/shared/errors/__init__.pyi
+byfrost/shared/errors/color.py
+byfrost/shared/errors/constant.py
+byfrost/shared/errors/interface.py
+byfrost/shared/errors/interface.pyi
+byfrost/shared/errors/loga.py
+byfrost/shared/errors/loga.pyi
+byfrost/shared/request/__init__.py
+byfrost/shared/request/__init__.pyi
+byfrost/shared/request/builder.py
+byfrost/shared/types/__init__.py
+byfrost/shared/types/dataclass/__init__.py
+byfrost/shared/types/dataclass/__init__.pyi
+byfrost/shared/types/dataclass/bridge.py
+byfrost/shared/types/dataclass/file.py
+byfrost/shared/types/typeddict/__init__.py
+byfrost/shared/types/typeddict/__init__.pyi
+byfrost/shared/types/typeddict/bridge.py
+byfrost/shared/types/typeddict/file.py
+tests/test_gcs.py
+tests/test_pinata.py
+tests/test_s3.py

bifrostsdk-1.0.0/bifrostsdk.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

bifrostsdk-1.0.0/bifrostsdk.egg-info/requires.txt

@@ -0,0 +1,4 @@
+google-cloud-storage>=2.5.0
+boto3>=1.34.0
+requests>=2.25.0
+requests-toolbelt>=1.0.0

bifrostsdk-1.0.0/bifrostsdk.egg-info/top_level.txt

@@ -0,0 +1 @@
+byfrost

bifrostsdk-1.0.0/byfrost/__init__.py

@@ -0,0 +1,46 @@
+#!usr/bin/env python3
+
+from .shared.types.dataclass.bridge import BridgeConfig, RainbowBridge
+from .shared.types.dataclass.file import File, MultiFile, Options
+
+from .shared.types.typeddict.bridge import BridgeConfigDict
+from .shared.types.typeddict.file import (
+    OptionsDict,
+    FileDict,
+    MultiFileDict,
+    ParamFileDict,
+    ParamDataDict,
+    ParamDict,
+    UploadedFileDict,
+)
+
+from .shared.errors.constant import (
+    ErrBadRequest,
+    ErrClientError,
+    ErrIncompleteMultiFileUpload,
+    ErrInvalidBucket,
+    ErrInvalidConfig,
+    ErrInvalidCredentials,
+    ErrInvalidProvider,
+    ErrUnauthorized,
+    ErrFileOperationFailed,
+)
+from .shared.errors.interface import BifrostError
+from .shared.config.provider import (
+    GoogleCloudStorage,
+    PinataCloud,
+    SimpleStorageService,
+)
+
+from .shared.config.option import (
+    OptACL,
+    ACLPublicRead,
+    ACLPrivate,
+    OptContentType,
+    OptMetadata,
+    OptPinata,
+)
+
+from .bifrost import new_rainbow_bridge
+
+__name__ = "byfrost"

bifrostsdk-1.0.0/byfrost/__init__.pyi

@@ -0,0 +1,81 @@
+#!usr/bin/env python3
+
+from .shared.types.dataclass.bridge import BridgeConfig, RainbowBridge
+from .shared.types.dataclass.file import File, MultiFile, Options
+
+from .shared.types.typeddict.bridge import BridgeConfigDict
+from .shared.types.typeddict.file import (
+    OptionsDict,
+    FileDict,
+    MultiFileDict,
+    ParamFileDict,
+    ParamDataDict,
+    ParamDict,
+    UploadedFileDict,
+)
+
+from .shared.errors.constant import (
+    ErrBadRequest,
+    ErrClientError,
+    ErrIncompleteMultiFileUpload,
+    ErrInvalidBucket,
+    ErrInvalidConfig,
+    ErrInvalidCredentials,
+    ErrInvalidProvider,
+    ErrUnauthorized,
+    ErrFileOperationFailed,
+)
+from .shared.errors.interface import BifrostError
+from .shared.config.provider import (
+    GoogleCloudStorage,
+    PinataCloud,
+    SimpleStorageService,
+)
+
+from .shared.config.option import (
+    OptACL,
+    ACLPublicRead,
+    ACLPrivate,
+    OptContentType,
+    OptMetadata,
+    OptPinata,
+)
+
+from .bifrost import new_rainbow_bridge
+
+__name__ = "byfrost"
+__all__ = [
+    "BridgeConfig",
+    "RainbowBridge",
+    "File",
+    "Options",
+    "MultiFile",
+    "BridgeConfigDict",
+    "OptionsDict",
+    "FileDict",
+    "MultiFileDict",
+    "ParamFileDict",
+    "ParamDataDict",
+    "ParamDict",
+    "UploadedFileDict",
+    "ErrBadRequest",
+    "ErrClientError",
+    "ErrIncompleteMultiFileUpload",
+    "ErrInvalidBucket",
+    "ErrInvalidConfig",
+    "ErrInvalidCredentials",
+    "ErrInvalidProvider",
+    "ErrUnauthorized",
+    "ErrFileOperationFailed",
+    "BifrostError",
+    "GoogleCloudStorage",
+    "PinataCloud",
+    "SimpleStorageService",
+    "new_rainbow_bridge",
+    "OptACL",
+    "ACLPublicRead",
+    "ACLPrivate",
+    "OptContentType",
+    "OptMetadata",
+    "OptPinata",
+]