python-postman 0.2.0__tar.gz → 0.6.0__tar.gz

{python-postman-0.2.0 → python_postman-0.6.0}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 Yudiell
-
-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.
+MIT License
+
+Copyright (c) 2022 Yudiell
+
+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.

python_postman-0.6.0/PKG-INFO

@@ -0,0 +1,52 @@
+Metadata-Version: 2.1
+Name: python-postman
+Version: 0.6.0
+Summary: Pypostman allows users to parse postman environments and postman collections.
+Author: Data Engineering Team
+Author-email: DataEngineering@loves.com
+Requires-Python: >=3.8.1,<4.0.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: boto3 (>=1.34.67,<2.0.0)
+Requires-Dist: cryptography (>=42.0.5,<43.0.0)
+Requires-Dist: logbook (>=1.7.0.post0,<2.0.0)
+Requires-Dist: pendulum (>=3.0.0,<4.0.0)
+Requires-Dist: pydantic (>=2.6.4,<3.0.0)
+Requires-Dist: pytz (>=2024.1,<2025.0)
+Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
+Requires-Dist: requests (>=2.32.3,<3.0.0)
+Requires-Dist: urllib3 (>=1.25.4,<2.0.0)
+Description-Content-Type: text/markdown
+
+# Python Postman
+
+**pypostman** is a command-line interface that allows to `automate` multiple api calls from postman collections, additionally it also allow you to `compress` and `save` the response to a local directory or to an AWS S3 bucket.
+Thereby allowing you to manage your api calls using postman, then `automate` and `process` their response using python.
+
+Example:
+
+```
+https://github.com/yudiell/energy-apis
+```
+
+### Included Modules
+- http.py
+- logger.py
+
+## Installation
+See the example.
+
+### Python >= 3.8.1
+
+Pypi:
+  ```  
+  pip install python-postman
+  ```
+
+## How to Use It
+
+See example
+

python_postman-0.6.0/README.md

@@ -0,0 +1,28 @@
+# Python Postman
+
+**pypostman** is a command-line interface that allows to `automate` multiple api calls from postman collections, additionally it also allow you to `compress` and `save` the response to a local directory or to an AWS S3 bucket.
+Thereby allowing you to manage your api calls using postman, then `automate` and `process` their response using python.
+
+Example:
+
+```
+https://github.com/yudiell/energy-apis
+```
+
+### Included Modules
+- http.py
+- logger.py
+
+## Installation
+See the example.
+
+### Python >= 3.8.1
+
+Pypi:
+  ```  
+  pip install python-postman
+  ```
+
+## How to Use It
+
+See example

python_postman-0.6.0/pyproject.toml

@@ -0,0 +1,59 @@
+[tool.poetry]
+name = "python-postman"
+version = "0.6.0"
+description = "Pypostman allows users to parse postman environments and postman collections."
+authors = ["Data Engineering Team <DataEngineering@loves.com>"]
+readme = "README.md"
+
+[tool.isort]
+profile = "black"
+
+
+[tool.poetry.dependencies]
+python = "^3.8.1"
+requests = "^2.32.3"
+pyyaml = "^6.0.1"
+pydantic = "^2.6.4"
+cryptography = "^42.0.5"
+urllib3 = "^1.25.4"
+logbook = "^1.7.0.post0"
+pendulum = "^3.0.0"
+boto3 = "^1.34.67"
+pytz = "^2024.1"
+
+
+[tool.poetry.group.lint.dependencies]
+flake8-annotations = "^3.0.1"
+flake8-builtins = "^2.1.0"
+flake8-docstrings = "^1.7.0"
+flake8-eradicate = "^1.5.0"
+flake8-future-annotations = "^1.1.0"
+flake8-isort = "^6.0.0"
+flake8-new-union-types = "^0.4.1"
+flake8-pep585 = "^0.1.7"
+flake8-secure-coding-standard = "^1.4.0"
+flake8-type-checking = "^2.4.1"
+flake8-use-pathlib = "^0.3.0"
+flake8-variables-names = "^0.0.6"
+pep8-naming = "^0.13.3"
+black = "^24.3.0"
+isort = "^5.12.0"
+pip-audit = "^2.6.1"
+mypy = "^1.9.0"
+
+
+[tool.poetry.group.test.dependencies]
+pytest = "^7.4.0"
+
+
+[tool.poetry.group.dev.dependencies]
+pre-commit = "^3.3.3"
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+
+[tool.poetry.scripts]
+pypostman = "pypostman.__main__:main"

{python-postman-0.2.0/pypostman → python_postman-0.6.0/src/python_postman}/__main__.py

@@ -1,17 +1,17 @@
-from typing import List
-
-from pypostman import postman
-from .environment import Environment
-from .collection import Collection
-
-
-def main():
-    environments_dir = "pypostman/environments"
-    environments: List[Environment] = postman._get_environments(dir=environments_dir)
-
-    collections_dir = "pypostman/collections"
-    collections: List[Collection] = postman._get_collections(dir=collections_dir)
-
-
-if __name__ == "__main__":
-    main()
+from typing import List
+
+from pypostman import postman
+from .environment import Environment
+from .collection import Collection
+
+
+def main():
+    environments_dir = "pypostman/environments"
+    environments: List[Environment] = postman._get_environments(dir=environments_dir)
+
+    collections_dir = "pypostman/collections"
+    collections: List[Collection] = postman._get_collections(dir=collections_dir)
+
+
+if __name__ == "__main__":
+    main()

{python-postman-0.2.0/pypostman → python_postman-0.6.0/src/python_postman}/auth.py

@@ -1,77 +1,77 @@
-from requests.auth import HTTPBasicAuth, AuthBase
-
-from .config import Auth as ConfigAuth
-
-
-class BearerAuth(AuthBase):
-    def __init__(self, token):
-        self.token = token
-
-    def __call__(self, r):
-        r.headers["Authorization"] = f"Bearer {self.token}"
-        return r
-
-
-class ApiKeyAuth(AuthBase):
-    def __init__(self, apikey):
-        self.apikey = apikey
-
-    def __call__(self, r):
-        """
-        The postman collection auth determines
-        where the apikey should be applied.
-        1. Query: Is to be added to the query params.
-        2. Header: Is to be added to the header.
-        The postman collection auth apikey is to be applied to -
-        the query params if the auth api key contains the key "in".
-        """
-        key = self.apikey["key"]
-        value = self.apikey["value"]
-        if self.apikey.get("in") is not None:
-            r.prepare_url(url=r.url, params={key: value})
-        else:
-            r.headers[key] = value
-        return r
-
-
-class Auth:
-    def __init__(self, auth: ConfigAuth):
-        self.type = auth.type if auth else None
-        self.__auth_config = (
-            auth.noauth or auth.basic or auth.apikey or auth.bearer if auth else None
-        )
-
-        self.http_auth = (
-            self.noauth or self.basic or self.apikey or self.bearer if auth else None
-        )
-
-    @property
-    def noauth(self) -> None:
-        if self.__auth_config and self.type == "noauth":
-            return None
-
-    @property
-    def basic(self) -> HTTPBasicAuth:
-        if self.__auth_config and self.type == "basic":
-            basic = {}
-            for item in self.__auth_config:
-                basic[item.key] = item.value
-            # print(basic)
-            return HTTPBasicAuth(username=basic["username"], password=basic["password"])
-
-    @property
-    def apikey(self) -> ApiKeyAuth:
-        if self.__auth_config and self.type == "apikey":
-            apikey = {}
-            for item in self.__auth_config:
-                apikey[item.key] = item.value
-            return ApiKeyAuth(apikey=apikey)
-
-    @property
-    def bearer(self) -> BearerAuth:
-        if self.__auth_config and self.type == "bearer":
-            bearer = {}
-            for item in self.__auth_config:
-                bearer[item.key] = item.value
-            # print(bearer)
-            return BearerAuth(token=bearer["token"])
+from requests.auth import HTTPBasicAuth, AuthBase
+
+from .config import Auth as ConfigAuth
+
+
+class BearerAuth(AuthBase):
+    def __init__(self, token):
+        self.token = token
+
+    def __call__(self, r):
+        r.headers["Authorization"] = f"Bearer {self.token}"
+        return r
+
+
+class ApiKeyAuth(AuthBase):
+    def __init__(self, apikey):
+        self.apikey = apikey
+
+    def __call__(self, r):
+        """
+        The postman collection auth determines
+        where the apikey should be applied.
+        1. Query: Is to be added to the query params.
+        2. Header: Is to be added to the header.
+        The postman collection auth apikey is to be applied to -
+        the query params if the auth api key contains the key "in".
+        """
+        key = self.apikey["key"]
+        value = self.apikey["value"]
+        if self.apikey.get("in") is not None:
+            r.prepare_url(url=r.url, params={key: value})
+        else:
+            r.headers[key] = value
+        return r
+
+
+class Auth:
+    def __init__(self, auth: ConfigAuth):
+        self.type = auth.type if auth else None
+        self.__auth_config = (
+            auth.noauth or auth.basic or auth.apikey or auth.bearer if auth else None
+        )
+
+        self.http_auth = (
+            self.noauth or self.basic or self.apikey or self.bearer if auth else None
+        )
+
+    @property
+    def noauth(self) -> None:
+        if self.__auth_config and self.type == "noauth":
+            return None
+
+    @property
+    def basic(self) -> HTTPBasicAuth:
+        if self.__auth_config and self.type == "basic":
+            basic = {}
+            for item in self.__auth_config:
+                basic[item.key] = item.value
+            # print(basic)
+            return HTTPBasicAuth(username=basic["username"], password=basic["password"])
+
+    @property
+    def apikey(self) -> ApiKeyAuth:
+        if self.__auth_config and self.type == "apikey":
+            apikey = {}
+            for item in self.__auth_config:
+                apikey[item.key] = item.value
+            return ApiKeyAuth(apikey=apikey)
+
+    @property
+    def bearer(self) -> BearerAuth:
+        if self.__auth_config and self.type == "bearer":
+            bearer = {}
+            for item in self.__auth_config:
+                bearer[item.key] = item.value
+            # print(bearer)
+            return BearerAuth(token=bearer["token"])

python_postman-0.6.0/src/python_postman/body.py

@@ -0,0 +1,33 @@
+from typing import Dict
+from .config import Body
+
+
+class Body:
+    def __init__(self, body: Body) -> None:
+        self.mode = body.mode
+        self.raw = body.raw
+        self.options = body.options
+        self.formdata = body.formdata
+        self.urlencoded = body.urlencoded
+
+    @property
+    def urlencoded_as_dict(self) -> Dict[str, str]:
+        if not self.urlencoded:
+            return None
+
+        body = {}
+        for option in self.urlencoded:
+            if not option.get("disabled", False):
+                body[option["key"]] = option["value"]
+        return body
+
+    @property
+    def formdata_as_dict(self) -> Dict[str, str]:
+        if not self.formdata:
+            return None
+
+        body = {}
+        for option in self.formdata:
+            if not option.get("disabled", False):
+                body[option["key"]] = option["value"]
+        return body

{python-postman-0.2.0/pypostman → python_postman-0.6.0/src/python_postman}/collection.py

@@ -1,36 +1,36 @@
-import os
-import json
-from pathlib import Path
-
-from .config import Config
-from .variable import Variables
-from .auth import Auth
-from .event import Events
-from .item import Items
-from .template import CustomTemplate
-
-
-class Collection:
-    def __init__(self, collection_file) -> None:
-        with open(Path(collection_file)) as file:
-            text = file.read().replace("{{", "${").replace("}}", "}")
-            template: str = CustomTemplate(text).safe_substitute(os.environ)
-            data: dict = json.loads(template)
-
-        self._template = template
-        self._collection = Config(**data)
-        self._info = self._collection.info
-        self._variables: Variables = Variables(variables=self._collection.variables)
-        self._auth: Auth = Auth(auth=self._collection.auth)
-        self._events = Events(events=self._collection.events)
-        self._test = self._events.test
-        self._prerequest = self._events.prerequest
-        self._items: Items = Items(items=self._collection.items)
-        self._requests = self._items.requests()
-        for request in self._requests:
-            request.auth = self._auth if not request.auth else request.auth
-            if request.url:
-                template: str = CustomTemplate(request.url.base).safe_substitute(
-                    self._variables.as_dict
-                )
-                request.url.base_url = template
+import os
+import json
+from pathlib import Path
+
+from .config import Config
+from .variable import Variables
+from .auth import Auth
+from .event import Events
+from .item import Items
+from .template import CustomTemplate
+
+
+class Collection:
+    def __init__(self, collection_file) -> None:
+        with open(Path(collection_file)) as file:
+            text = file.read().replace("{{", "${").replace("}}", "}")
+            template: str = CustomTemplate(text).safe_substitute(os.environ)
+            data: dict = json.loads(template)
+
+        self._template = template
+        self._collection = Config(**data)
+        self._info = self._collection.info
+        self._variables: Variables = Variables(variables=self._collection.variables)
+        self._auth: Auth = Auth(auth=self._collection.auth)
+        self._events = Events(events=self._collection.events)
+        self._test = self._events.test
+        self._prerequest = self._events.prerequest
+        self._items: Items = Items(items=self._collection.items)
+        self._requests = self._items.requests()
+        for request in self._requests:
+            request.auth = self._auth if not request.auth else request.auth
+            if request.url:
+                template: str = CustomTemplate(request.url.base).safe_substitute(
+                    self._variables.as_dict
+                )
+                request.url.base_url = template

python_postman-0.6.0/src/python_postman/config.py

@@ -0,0 +1,110 @@
+from typing import List, Dict, Union, Optional
+from pydantic import Field, BaseModel
+
+
+class Info(BaseModel):
+    postman_id: str = Field(None, alias="_postman_id")
+    name: str
+    postman_schema: str = Field(None, alias="schema")
+    exporter_id: str = Field(None, alias="_exporter_id")
+
+
+# Variable Related Objects
+class Variables(BaseModel):
+    key: Optional[str] = None
+    value: Optional[str] = None
+    type: Optional[str] = None
+    disabled: Optional[bool] = None
+
+
+# Auth Related Objects
+class AuthValues(BaseModel):
+    key: str
+    value: str
+    type: str
+    disabled: Optional[bool] = None
+
+
+class Auth(BaseModel):
+    type: str
+    noauth: Optional[List[AuthValues]] = None
+    basic: Optional[List[AuthValues]] = None
+    apikey: Optional[List[AuthValues]] = None
+    bearer: Optional[List[AuthValues]] = None
+
+
+# Collection and Request Related Objects
+class Script(BaseModel):
+    type: Optional[str] = None
+    exec: List[str]
+
+
+class Event(BaseModel):
+    listen: Optional[str] = None
+    script: Optional[Script] = None
+
+
+# Request Related Objects
+class Header(BaseModel):
+    key: Optional[str] = None
+    value: Optional[str] = None
+    description: Optional[str] = None
+    disabled: Optional[bool] = None
+
+
+class Variable(BaseModel):
+    key: Optional[str] = None
+    value: Optional[str] = None
+    description: Optional[str] = None
+
+
+class Param(BaseModel):
+    key: Optional[str] = None
+    value: Optional[str] = None
+    description: Optional[str] = None
+    disabled: Optional[bool] = None
+
+
+class Body(BaseModel):
+    mode: Optional[str] = None
+    raw: Optional[str] = None
+    formdata: Optional[List[Dict[str, Union[str, bool]]]] = None
+    urlencoded: Optional[List[Dict[str, Union[str, bool]]]] = None
+    options: Optional[Dict[str, Dict[str, Union[str, bool]]]] = None
+
+
+class Url(BaseModel):
+    raw: Optional[str] = None
+    protocol: Optional[str] = None
+    host: Optional[List[str]] = None
+    path: Optional[List[str]] = None
+    variable: Optional[List[Variable]] = None
+    query: Optional[List[Param]] = None
+
+
+class Request(BaseModel):
+    auth: Optional[Auth] = None
+    method: str
+    headers: List[Header] = Field(None, alias="header")
+    url: Optional[Url] = None
+    body: Optional[Body] = None
+
+
+# Collection Related Objects
+class Item(BaseModel):
+    name: str
+    item: Optional[List["Item"]] = None
+    events: Optional[List[Event]] = Field(None, alias="event")
+    request: Optional[Request] = None
+
+    @property
+    def type(self):
+        return "request" if self.request else "folder"
+
+
+class Config(BaseModel):
+    info: Optional[Info] = None
+    items: Optional[List[Item]] = Field(None, alias="item")
+    variables: Optional[List[Variables]] = Field(None, alias="variable")
+    events: Optional[List[Event]] = Field(None, alias="event")
+    auth: Optional[Auth] = None