Merge pull request #182 from intelowlproject/develop

4.4.0

Author: mlodic

.github/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## [4.4.0](https://github.com/intelowlproject/pyintelowl/releases/tag/4.4.0)
+- this version supports the usage of a proxy while connecting to IntelOwl via Python code.
+
 ## [4.3.0](https://github.com/intelowlproject/pyintelowl/releases/tag/4.3.0)
 - this version supports the new Playbooks feature released with IntelOwl v4.1.0
 

.github/workflows/pythonpublish.yml

@@ -19,8 +19,8 @@ jobs:
         pip install setuptools wheel twine
     - name: Build and publish
       env:
-        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
-        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
       run: |
         python setup.py sdist bdist_wheel
         twine upload dist/*

README.md

@@ -62,7 +62,7 @@ Commands:
 
 ```python
 from pyintelowl import IntelOwl
-obj = IntelOwl("<your_api_key>", "<your_intelowl_instance_url>", "optional<path_to_pem_file>")
+obj = IntelOwl("<your_api_key>", "<your_intelowl_instance_url>", "optional<path_to_pem_file>", "optional<proxies>")
 ```
 
 For more comprehensive documentation, please see https://pyintelowl.readthedocs.io/.

docs/conf.py

@@ -13,7 +13,7 @@
 import os
 import sys
 
-VERSION = "4.3.0"
+VERSION = "4.4.0"
 GITHUB_URL = "https://github.com/intelowlproject/pyintelowl"
 
 sys.path.append(os.path.abspath("../"))

docs/index.rst

@@ -70,6 +70,7 @@ Usage as SDK/library
       "<your_api_key>",
       "<your_intelowl_instance_url>",
       "optional<path_to_pem_file>"
+      "optional<proxies>"
    )
    """
 

pyintelowl/main.py

@@ -27,7 +27,7 @@ def cli(ctx: ClickContext, debug: bool):
             cert = False
         elif cert in ["None", "True"]:
             cert = True
-        ctx.obj = IntelOwl(api_key, url, cert, logger, cli=True)
+        ctx.obj = IntelOwl(api_key, url, cert, {}, logger, cli=True)
 
 
 # Compile all groups and commands

pyintelowl/pyintelowl.py

@@ -24,17 +24,21 @@ def __init__(
         token: str,
         instance_url: str,
         certificate: str = None,
+        proxies: dict = None,
         logger: logging.Logger = None,
         cli: bool = False,
     ):
         self.token = token
         self.instance = instance_url
         self.certificate = certificate
-        self.cli = cli
         if logger:
             self.logger = logger
         else:
             self.logger = logging.getLogger(__name__)
+        if proxies and not isinstance(proxies, dict):
+            raise TypeError("proxies param must be a dictionary")
+        self.proxies = proxies
+        self.cli = cli
 
     @property
     def session(self) -> requests.Session:
@@ -45,6 +49,8 @@ def session(self) -> requests.Session:
             session = requests.Session()
             if self.certificate is not True:
                 session.verify = self.certificate
+            if self.proxies:
+                session.proxies = self.proxies
             session.headers.update(
                 {
                     "Authorization": f"Token {self.token}",

pyintelowl/version.py

@@ -1 +1 @@
-__version__ = "4.3.0"
+__version__ = "4.4.0"