email-core-lib 0.0.0.1__tar.gz

email_core_lib-0.0.0.1/LICENSE_2022_4_19

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright 2022 Shay Tesler
+
+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 pay, 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.

email_core_lib-0.0.0.1/MANIFEST.in

@@ -0,0 +1,9 @@
+include requirements.txt
+include LICENSE
+include README.md
+
+
+global-exclude *.pyc
+global-exclude __pycache__
+recursive-include hydra_plugins/* *.yaml
+recursive-include email_core_lib/* *.yaml

email_core_lib-0.0.0.1/PKG-INFO

@@ -0,0 +1,97 @@
+Metadata-Version: 2.4
+Name: email_core_lib
+Version: 0.0.0.1
+Summary: Email Core Lib
+Home-page: https://github.com/shay-te/email-core-lib/
+Author: Shay Tessler
+Author-email: shay.te@gmail.com
+License: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Topic :: Software Development
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE_2022_4_19
+Requires-Dist: eventlet
+Requires-Dist: mailchimp-transactional
+Requires-Dist: sib-api-v3-sdk
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# EmailCoreLib
+`EmailCoreLib` uses [Celery](https://docs.celeryq.dev/en/stable/getting-started/introduction.html) and [MailChimp](https://mailchimp.com/) to receive data and send emails.
+It uses `Celery` to listen to a queue and receive data over it, and `MailChimp` is used to fire emails using their [Transactional Email](https://mailchimp.com/features/transactional-email/) service.
+
+## Services
+- Send Emails using MailChimp
+- Starts Celery Worker to handle requests
+
+## Config 
+```yaml
+core_lib:
+  email_core_lib:
+    amqp:
+      url:
+        protocol: amqp
+        username: ${oc.env:AMQP_USERNAME}
+        password: ${oc.env:AMQP_PASSWORD}
+        host: ${oc.env:AMQP_HOST}
+        port: ${oc.env:AMQP_PORT}
+    client:
+      _target_: email_core_lib.client.mailchimp_client.MailChimpClient
+      api_key: your_mailchimp_transactional_api_key
+```
+
+## celery_main.py
+This is the main file that will start the `Celery` worker and initialize the `EmailCoreLib`. As soon as a task is 
+dispatched for `task.send` it will use the `MailchimpTransactional` client to send the email.
+
+## EmailCoreLib
+```python
+class EmailCoreLib(CoreLib):
+    def __init__(self, conf: DictConfig):
+        super().__init__()
+        self.config = conf
+        self.mailchimp = instantiate_config(self.config.core_lib.email_core_lib.client)
+```
+Uses `CoreLib`'s `instantiate_config` that will instantiate the `MailChimpClient` from the config yaml.
+
+## MailChimp Client
+This client will be initialized as soon as the `Celery` worker has started and the `EmailCoreLib` is initialized
+
+### Functions
+```python
+def send(self, template_name: str, params: dict):
+```
+
+`template_name` (*str*): Name of the saved template in your MailChimp Transactional account
+
+`params` (*dict*): A `dict` of variables as keys and their values that are saved in the template to be replaced.
+
+## Example
+```python
+import hydra
+from celery import Celery
+
+hydra.initialize(config_path='config_path', caller_stack_depth=1)
+cfg = hydra.compose('config.yaml')
+
+app = Celery()
+app.config_from_object(cfg.core_lib.email_core_lib.amqp.url)
+app.autodiscover_tasks()
+
+app.send_task('task.send',
+                ['register_complete', {'email': 'john@example.com', 'plan': 'some plan'}]
+              )
+```
+## License
+Licenced under [MIT](https://github.com/shay-te/email-core-lib/blob/master/LICENSE_2022_4_19)

email_core_lib-0.0.0.1/README.md

@@ -0,0 +1,68 @@
+# EmailCoreLib
+`EmailCoreLib` uses [Celery](https://docs.celeryq.dev/en/stable/getting-started/introduction.html) and [MailChimp](https://mailchimp.com/) to receive data and send emails.
+It uses `Celery` to listen to a queue and receive data over it, and `MailChimp` is used to fire emails using their [Transactional Email](https://mailchimp.com/features/transactional-email/) service.
+
+## Services
+- Send Emails using MailChimp
+- Starts Celery Worker to handle requests
+
+## Config 
+```yaml
+core_lib:
+  email_core_lib:
+    amqp:
+      url:
+        protocol: amqp
+        username: ${oc.env:AMQP_USERNAME}
+        password: ${oc.env:AMQP_PASSWORD}
+        host: ${oc.env:AMQP_HOST}
+        port: ${oc.env:AMQP_PORT}
+    client:
+      _target_: email_core_lib.client.mailchimp_client.MailChimpClient
+      api_key: your_mailchimp_transactional_api_key
+```
+
+## celery_main.py
+This is the main file that will start the `Celery` worker and initialize the `EmailCoreLib`. As soon as a task is 
+dispatched for `task.send` it will use the `MailchimpTransactional` client to send the email.
+
+## EmailCoreLib
+```python
+class EmailCoreLib(CoreLib):
+    def __init__(self, conf: DictConfig):
+        super().__init__()
+        self.config = conf
+        self.mailchimp = instantiate_config(self.config.core_lib.email_core_lib.client)
+```
+Uses `CoreLib`'s `instantiate_config` that will instantiate the `MailChimpClient` from the config yaml.
+
+## MailChimp Client
+This client will be initialized as soon as the `Celery` worker has started and the `EmailCoreLib` is initialized
+
+### Functions
+```python
+def send(self, template_name: str, params: dict):
+```
+
+`template_name` (*str*): Name of the saved template in your MailChimp Transactional account
+
+`params` (*dict*): A `dict` of variables as keys and their values that are saved in the template to be replaced.
+
+## Example
+```python
+import hydra
+from celery import Celery
+
+hydra.initialize(config_path='config_path', caller_stack_depth=1)
+cfg = hydra.compose('config.yaml')
+
+app = Celery()
+app.config_from_object(cfg.core_lib.email_core_lib.amqp.url)
+app.autodiscover_tasks()
+
+app.send_task('task.send',
+                ['register_complete', {'email': 'john@example.com', 'plan': 'some plan'}]
+              )
+```
+## License
+Licenced under [MIT](https://github.com/shay-te/email-core-lib/blob/master/LICENSE_2022_4_19)

email_core_lib-0.0.0.1/email_core_lib/__init__.py

@@ -0,0 +1,2 @@
+# Version of the core_lib
+__version__ = '0.0.0.1'

email_core_lib-0.0.0.1/email_core_lib/client/mailchimp_client.py

@@ -0,0 +1,44 @@
+import logging
+
+import mailchimp_transactional as MailchimpTransactional
+from mailchimp_transactional.api_client import ApiClientError
+
+
+class MailChimpClient:
+    def __init__(self, api_key: str):
+        self.logger = logging.getLogger(self.__class__.__name__)
+        self.api_key = api_key
+        self.mailchimp = MailchimpTransactional.Client(self.api_key)
+
+    def send(self, template_name: str, params: dict):
+        template_content = []
+        for key, val in params.items():
+            if key != 'email':
+                template_content.append({
+                    'name': key,
+                    'content': str(val)
+                })
+        message = {
+            "to": [
+                {
+                    "email": params['email'],
+                    "type": "to"
+                }
+            ],
+            "merge_language": "handlebars",
+            "merge": True,
+            "global_merge_vars": template_content,
+        }
+        try:
+            response = self.mailchimp.messages.send_template(
+                {"template_name": template_name, "template_content": template_content, "message": message}
+            )
+            if response and len(response) > 0:
+                return True if response[0].get('status') == 'sent' else False
+            return False
+        except ApiClientError as error:
+            self.logger.error(f'An exception occurred: {error.text}')
+            self.logger.error(error)
+        except Exception as error:
+            self.logger.error(error)
+        return False

email_core_lib-0.0.0.1/email_core_lib/client/send_in_blue_client.py

@@ -0,0 +1,47 @@
+import logging
+
+import requests
+import sib_api_v3_sdk
+from sib_api_v3_sdk.rest import ApiException
+
+SENDER = {"name": "una", "email": "noreply@getuna.ai"}
+
+
+class SendInBlueClient:
+    def __init__(self, api_key: str, slack_email_error_url: str):
+        self.logger = logging.getLogger(self.__class__.__name__)
+        self.api_key = api_key
+        self._slack_email_error_url = slack_email_error_url
+        configuration = sib_api_v3_sdk.Configuration()
+        configuration.api_key['api-key'] = api_key
+        self.api_instance = sib_api_v3_sdk.TransactionalEmailsApi(sib_api_v3_sdk.ApiClient(configuration))
+
+    def send(self, template_name: str, params: dict, sender_info: dict = None, tags: list = None):
+        sender = sender_info if sender_info else SENDER
+        send_smtp_email = sib_api_v3_sdk.SendSmtpEmail(
+            to=[{"email": params['email']}],
+            template_id=int(template_name),
+            params=params,
+            sender=sender,
+            tags=tags
+        )
+        try:
+            self.api_instance.send_transac_email(send_smtp_email)
+            return True
+        except ApiException as e:
+            print("Exception when calling SMTPApi->send_transac_email: %s\n" % e)
+            self.logger.error(f'An exception occurred: {e}')
+            self.logger.error(e)
+            self._notify_slack(f'```An ApiException occurred when sending email: {e}```')
+        except Exception as error:
+            self.logger.error(error)
+            self._notify_slack(f'```An Exception occurred when sending email: {error}```')
+        return False
+
+    def _notify_slack(self, message):
+        if self._slack_email_error_url:
+            requests.post(self._slack_email_error_url, json={'text': message}, timeout=5)
+
+# if __name__ == '__main__':
+#     s = SendInBlueClient('CODE', '')
+#     s.send(1, {"CODE": "123123", "subject": "Your code", "email": "shay.te@gmail.com"})

email_core_lib-0.0.0.1/email_core_lib/config/email_core_lib.yaml

@@ -0,0 +1,16 @@
+# @package _global_
+core_lib:
+  email_core_lib:
+    amqp:
+      url:
+        protocol: amqp
+        username: ${oc.env:AMQP_USERNAME}
+        password: ${oc.env:AMQP_PASSWORD}
+        host: ${oc.env:AMQP_HOST}
+        port: ${oc.env:AMQP_PORT}
+    client:
+#      _target_: email_core_lib.client.mailchimp_client.MailChimpClient
+#      api_key: ${oc.env:EMIL_CORE_LIB_MAILCHIMP_API_KEY}
+      _target_: email_core_lib.client.send_in_blue_client.SendInBlueClient
+      api_key: ${oc.env:EMIL_CORE_LIB_SEND_IN_BLUE_API_KEY}
+      slack_email_error_url: ${oc.env:SLACK_WEBHOOK_URL_ERRORS_EMAIL}

email_core_lib-0.0.0.1/email_core_lib/email_core_lib.py

@@ -0,0 +1,17 @@
+import logging
+
+from omegaconf import DictConfig
+from core_lib.core_lib import CoreLib
+from core_lib.helpers.config_instances import instantiate_config
+
+
+class EmailCoreLib(CoreLib):
+    def __init__(self, conf: DictConfig):
+        super().__init__()
+        self.logger = logging.getLogger(self.__class__.__name__)
+        self.config = conf
+        self.mail_client = instantiate_config(self.config.core_lib.email_core_lib.client)
+
+    def send(self, template_id, params, sender_info, tags):
+        self.logger.info(f'send email. template_id: {template_id}, params: {params}, sender_info: {sender_info}, tags: {tags}')
+        self.mail_client.send(template_id, params, sender_info, tags)

email_core_lib-0.0.0.1/email_core_lib.egg-info/PKG-INFO

@@ -0,0 +1,97 @@
+Metadata-Version: 2.4
+Name: email_core_lib
+Version: 0.0.0.1
+Summary: Email Core Lib
+Home-page: https://github.com/shay-te/email-core-lib/
+Author: Shay Tessler
+Author-email: shay.te@gmail.com
+License: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Topic :: Software Development
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE_2022_4_19
+Requires-Dist: eventlet
+Requires-Dist: mailchimp-transactional
+Requires-Dist: sib-api-v3-sdk
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# EmailCoreLib
+`EmailCoreLib` uses [Celery](https://docs.celeryq.dev/en/stable/getting-started/introduction.html) and [MailChimp](https://mailchimp.com/) to receive data and send emails.
+It uses `Celery` to listen to a queue and receive data over it, and `MailChimp` is used to fire emails using their [Transactional Email](https://mailchimp.com/features/transactional-email/) service.
+
+## Services
+- Send Emails using MailChimp
+- Starts Celery Worker to handle requests
+
+## Config 
+```yaml
+core_lib:
+  email_core_lib:
+    amqp:
+      url:
+        protocol: amqp
+        username: ${oc.env:AMQP_USERNAME}
+        password: ${oc.env:AMQP_PASSWORD}
+        host: ${oc.env:AMQP_HOST}
+        port: ${oc.env:AMQP_PORT}
+    client:
+      _target_: email_core_lib.client.mailchimp_client.MailChimpClient
+      api_key: your_mailchimp_transactional_api_key
+```
+
+## celery_main.py
+This is the main file that will start the `Celery` worker and initialize the `EmailCoreLib`. As soon as a task is 
+dispatched for `task.send` it will use the `MailchimpTransactional` client to send the email.
+
+## EmailCoreLib
+```python
+class EmailCoreLib(CoreLib):
+    def __init__(self, conf: DictConfig):
+        super().__init__()
+        self.config = conf
+        self.mailchimp = instantiate_config(self.config.core_lib.email_core_lib.client)
+```
+Uses `CoreLib`'s `instantiate_config` that will instantiate the `MailChimpClient` from the config yaml.
+
+## MailChimp Client
+This client will be initialized as soon as the `Celery` worker has started and the `EmailCoreLib` is initialized
+
+### Functions
+```python
+def send(self, template_name: str, params: dict):
+```
+
+`template_name` (*str*): Name of the saved template in your MailChimp Transactional account
+
+`params` (*dict*): A `dict` of variables as keys and their values that are saved in the template to be replaced.
+
+## Example
+```python
+import hydra
+from celery import Celery
+
+hydra.initialize(config_path='config_path', caller_stack_depth=1)
+cfg = hydra.compose('config.yaml')
+
+app = Celery()
+app.config_from_object(cfg.core_lib.email_core_lib.amqp.url)
+app.autodiscover_tasks()
+
+app.send_task('task.send',
+                ['register_complete', {'email': 'john@example.com', 'plan': 'some plan'}]
+              )
+```
+## License
+Licenced under [MIT](https://github.com/shay-te/email-core-lib/blob/master/LICENSE_2022_4_19)

email_core_lib-0.0.0.1/email_core_lib.egg-info/SOURCES.txt

@@ -0,0 +1,22 @@
+LICENSE_2022_4_19
+MANIFEST.in
+README.md
+requirements.txt
+setup.py
+email_core_lib/__init__.py
+email_core_lib/email_core_lib.py
+email_core_lib.egg-info/PKG-INFO
+email_core_lib.egg-info/SOURCES.txt
+email_core_lib.egg-info/dependency_links.txt
+email_core_lib.egg-info/requires.txt
+email_core_lib.egg-info/top_level.txt
+email_core_lib/client/__init__.py
+email_core_lib/client/mailchimp_client.py
+email_core_lib/client/send_in_blue_client.py
+email_core_lib/config/__init__.py
+email_core_lib/config/email_core_lib.yaml
+hydra_plugins/email_core_lib/__init__.py
+hydra_plugins/email_core_lib/email_core_lib_sourcepath.py
+tests/__init__.py
+tests/test_celery.py
+tests/test_data/__init__.py

email_core_lib-0.0.0.1/email_core_lib.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

email_core_lib-0.0.0.1/email_core_lib.egg-info/requires.txt

@@ -0,0 +1,3 @@
+eventlet
+mailchimp-transactional
+sib-api-v3-sdk

email_core_lib-0.0.0.1/email_core_lib.egg-info/top_level.txt

@@ -0,0 +1,3 @@
+email_core_lib
+hydra_plugins
+tests

email_core_lib-0.0.0.1/hydra_plugins/email_core_lib/email_core_lib_sourcepath.py

@@ -0,0 +1,8 @@
+from hydra.plugins.search_path_plugin import SearchPathPlugin
+from hydra.core.config_search_path import ConfigSearchPath
+
+
+class EmailCoreLibSearchPathPlugin(SearchPathPlugin):
+    def manipulate_search_path(self, search_path: ConfigSearchPath) -> None:
+        assert isinstance(search_path, ConfigSearchPath)
+        search_path.append("email_core_lib", "pkg://email_core_lib.config")

email_core_lib-0.0.0.1/requirements.txt

@@ -0,0 +1,5 @@
+celery
+eventlet
+mailchimp-transactional
+sib-api-v3-sdk
+

email_core_lib-0.0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

email_core_lib-0.0.0.1/setup.py

@@ -0,0 +1,41 @@
+import os
+
+import setuptools
+
+import email_core_lib
+
+from setuptools import find_namespace_packages, setup
+from pip._internal.network.session import PipSession
+from pip._internal.req import parse_requirements
+
+dir_path = os.path.dirname(os.path.realpath(__file__))
+install_reqs = parse_requirements(os.path.join(dir_path, 'requirements.txt'), session=PipSession)
+requirements = []
+try:
+    requirements = [str(ir.req) for ir in install_reqs]
+except:
+    requirements = [str(ir.requirement) for ir in install_reqs]
+
+packages1 = setuptools.find_packages()
+packages2 = find_namespace_packages(include=['hydra_plugins.*'])
+packages = list(set(packages1 + packages2))
+
+with open('README.md', 'r') as fh:
+    long_description = fh.read()
+
+    setup(
+        name='email_core_lib',
+        version=email_core_lib.__version__,
+        author='Shay Tessler',
+        author_email='shay.te@gmail.com',
+        description='Email Core Lib',
+        long_description=long_description,
+        long_description_content_type='text/markdown',
+        url='https://github.com/shay-te/email-core-lib/',
+        packages=packages,
+        license='MIT',
+        classifiers=['Development Status :: 4 - Beta', 'Programming Language :: Python :: 3.7', 'Topic :: Software Development'],
+        install_requires=requirements,
+        include_package_data=True,
+        python_requires='>=3.7',
+    )

email_core_lib-0.0.0.1/tests/test_celery.py

@@ -0,0 +1,21 @@
+import os
+import unittest
+import hydra
+from celery import Celery
+from dotenv import load_dotenv
+
+from core_lib.data_layers.data.data_helpers import build_url
+
+path = os.path.join(os.path.dirname(__file__), 'test_data')
+load_dotenv(dotenv_path=os.path.join(path, '.env'))
+hydra.initialize(config_path='test_data', caller_stack_depth=1)
+cfg = hydra.compose('config.yaml')
+
+app = Celery(broker=build_url(**cfg.core_lib.email_core_lib.amqp.url))
+app.autodiscover_tasks()
+
+
+class Test(unittest.TestCase):
+    def test(self):
+        app.send_task('task.send',
+                      ['register_complete', {'email': 'shay@objectivelove.com'}])