markdown-merge 0.1.8__py3-none-any.whl

markdown_merge/__init__.py

@@ -0,0 +1,2 @@
+__version__ = "0.1.8"
+from .core import *

markdown_merge/_modidx.py

@@ -0,0 +1,19 @@
+# Autogenerated by nbdev
+
+d = { 'settings': { 'branch': 'master',
+                'doc_baseurl': '/markdown_merge',
+                'doc_host': 'https://AnswerDotAI.github.io',
+                'git_url': 'https://github.com/AnswerDotAI/markdown_merge',
+                'lib_path': 'markdown_merge'},
+  'syms': { 'markdown_merge.core': { 'markdown_merge.core.MarkdownMerge': ('core.html#markdownmerge', 'markdown_merge/core.py'),
+                                     'markdown_merge.core.MarkdownMerge.__init__': ( 'core.html#markdownmerge.__init__',
+                                                                                     'markdown_merge/core.py'),
+                                     'markdown_merge.core.MarkdownMerge.reset': ('core.html#markdownmerge.reset', 'markdown_merge/core.py'),
+                                     'markdown_merge.core.MarkdownMerge.send_msgs': ( 'core.html#markdownmerge.send_msgs',
+                                                                                      'markdown_merge/core.py'),
+                                     'markdown_merge.core.attach_file': ('core.html#attach_file', 'markdown_merge/core.py'),
+                                     'markdown_merge.core.create_multipart_msg': ( 'core.html#create_multipart_msg',
+                                                                                   'markdown_merge/core.py'),
+                                     'markdown_merge.core.get_addr': ('core.html#get_addr', 'markdown_merge/core.py'),
+                                     'markdown_merge.core.md2email': ('core.html#md2email', 'markdown_merge/core.py'),
+                                     'markdown_merge.core.smtp_connection': ('core.html#smtp_connection', 'markdown_merge/core.py')}}}

markdown_merge/core.py

@@ -0,0 +1,92 @@
+"""API details"""
+
+# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/00_core.ipynb.
+
+# %% auto 0
+__all__ = ['get_addr', 'attach_file', 'create_multipart_msg', 'md2email', 'smtp_connection', 'MarkdownMerge']
+
+# %% ../nbs/00_core.ipynb
+import os,mimetypes,smtplib
+
+from fastcore.utils import *
+from email.mime.multipart import MIMEMultipart
+from email.mime.text import MIMEText
+from email.mime.base import MIMEBase
+from email.policy import EmailPolicy
+from email import encoders
+
+from contextlib import contextmanager
+from markdown import markdown
+from email.headerregistry import Address
+from email.header import Header
+from time import sleep
+
+# %% ../nbs/00_core.ipynb
+def get_addr(email, name=None):
+    "Convert `email` and optional `name` into an email `Address` object"
+    return Address(email if name is None else name, addr_spec=email)
+
+# %% ../nbs/00_core.ipynb
+def attach_file(msg, f):
+    "Attach file `f` to message `msg`"
+    mtype,_ = mimetypes.guess_type(f)
+    main,sub = (mtype or 'application/octet-stream').split('/', 1)
+    part = MIMEBase(main, sub)
+    with open(f, 'rb') as fp: part.set_payload(fp.read())
+    encoders.encode_base64(part)
+    part['Content-Disposition'] = f'attachment; filename={Path(f).name}'
+    msg.attach(part)
+
+# %% ../nbs/00_core.ipynb
+def create_multipart_msg(subj, from_addr, to_addrs, md=None, html=None, attach=None, hdrs=None):
+    "Create a multipart email with markdown text and HTML"
+    msg = MIMEMultipart('alternative', policy=EmailPolicy())
+    msg['Subject'],msg['From'] = subj,str(from_addr)
+    for k,v in (hdrs or {}).items(): msg[k]=v
+    msg['To'] = ', '.join([str(a) for a in listify(to_addrs)])
+    if md: msg.attach(MIMEText(md, 'plain'))
+    if html: msg.attach(MIMEText(html, 'html'))
+    for f in listify(attach): attach_file(msg, f)
+    return msg
+
+# %% ../nbs/00_core.ipynb
+def md2email(subj, from_addr, to_addrs, md, attach=None, hdrs=None):
+    "Create a multipart email from markdown"
+    html = markdown(md)
+    return create_multipart_msg(subj, from_addr, to_addrs, md=md, html=html, attach=attach, hdrs=hdrs)
+
+# %% ../nbs/00_core.ipynb
+def smtp_connection(host, port, user=None, password=None, use_ssl=True, use_tls=False):
+    "Create and return an SMTP connection"
+    conn = smtplib.SMTP_SSL(host, port) if use_ssl else smtplib.SMTP(host, port)
+    if use_tls and not use_ssl: conn.starttls()
+    if user and password: conn.login(user, password)
+    return conn
+
+# %% ../nbs/00_core.ipynb
+class MarkdownMerge:
+    "Send templated email merge messages formatted with Markdown"
+    def __init__(self, addrs, from_addr, subj, msg, smtp_cfg=None, inserts=None, test=False, hdrs=None, env_from=None, attach=None):
+        self.addrs,self.from_addr,self.subj,self.msg,self.i = addrs,from_addr,subj,msg,0
+        self.inserts = [{}]*len(addrs) if inserts is None else inserts
+        self.smtp_cfg,self.test,self.hdrs,self.env_from,self.attach = smtp_cfg,test,hdrs,env_from,attach
+
+    def send_msgs(self, pause=0.2):
+        "Send all unsent messages to `addrs` with `pause` secs between each send"
+        conn = smtp_connection(**self.smtp_cfg)
+        while self.i < len(self.addrs):
+            addr,insert = self.addrs[self.i],self.inserts[self.i]
+            msg = self.msg.format(**insert)
+            eml = md2email(self.subj, self.from_addr, addr, md=msg, hdrs=self.hdrs, attach=self.attach)
+            if self.test: print(f"To: {addr}\n{'-'*40}\n{msg}\n{'='*40}\n")
+            else:
+                conn.send_message(eml, from_addr=self.env_from)
+                sleep(pause)
+            self.i += 1
+            if self.i%100==0:
+                print(self.i)
+                conn.quit()
+                conn = smtp_connection(**self.smtp_cfg)
+        conn.quit()
+
+    def reset(self): self.i=0

markdown_merge-0.1.8.dist-info/METADATA

@@ -0,0 +1,103 @@
+Metadata-Version: 2.4
+Name: markdown_merge
+Version: 0.1.8
+Summary: Send email using markdown
+Home-page: https://github.com/AnswerDotAI/markdown_merge
+Author: Jeremy Howard
+Author-email: github@jhoward.fastmail.fm
+License: Apache Software License 2.0
+Keywords: email mail markdown template
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: Apache Software License
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastcore
+Requires-Dist: markdown
+Provides-Extra: dev
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# MarkdownMerge
+
+
+<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
+
+## Install
+
+`pip install markdown_merge`
+
+## How to use
+
+### Provide your SMTP server settings, e.g. for AWS SES
+
+``` python
+import os
+```
+
+``` python
+servernm = 'email-smtp.us-west-2.amazonaws.com'
+username = os.getenv('SES_SMTP_USER')
+password = os.getenv('SES_SMTP_PASS')
+smtp_cfg = dict(host=servernm, port=587, user=username, password=password, use_ssl=False, use_tls=True)
+```
+
+You can configure your SMTP server settings using the `smtp_cfg`
+dictionary format shown above. The example uses AWS SES with environment
+variables for credentials.
+
+### Provide your email details
+
+``` python
+from_addr = get_addr('XXX@fastmail.com', 'Jeremy Howard')
+to_addrs = [get_addr('douglas@example.com', 'Douglas Adams'),
+            get_addr('cleese@example.com', 'John Cleese')]
+inserts  = [{'special': "Thanks for all the fish."},
+            {'special': "That was a silly walk."}]
+
+msg = """## Hello there!
+
+Here is your special message: *{special}*"""
+```
+
+``` python
+ml = MarkdownMerge(to_addrs, from_addr, 'A message', msg, smtp_cfg=smtp_cfg, inserts=inserts, test=True)
+```
+
+The `test=True` parameter prints the messages instead of sending them.
+
+### Send your messages
+
+``` python
+ml.send_msgs()
+```
+
+    To: Douglas Adams <douglas@example.com>
+    ----------------------------------------
+    ## Hello there!
+
+    Here is your special message: *Thanks for all the fish.*
+    ========================================
+
+    To: John Cleese <cleese@example.com>
+    ----------------------------------------
+    ## Hello there!
+
+    Here is your special message: *That was a silly walk.*
+    ========================================

markdown_merge-0.1.8.dist-info/RECORD

@@ -0,0 +1,9 @@
+markdown_merge/__init__.py,sha256=BRuiBzuT7KVxftzvlbGPTZX4-tFAp7KeBjgqyGFeME8,42
+markdown_merge/_modidx.py,sha256=bTtmxhhVACnK8Nd0w4hRAiZpu2BfygE6XNW2Qvsij14,1764
+markdown_merge/core.py,sha256=uOUYTpRnC7stcSTgkuhNT0TaCGX-FhT_1YQb4Nwm79w,3783
+markdown_merge-0.1.8.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+markdown_merge-0.1.8.dist-info/METADATA,sha256=HxBp2NDtaAywFc19MOdDRrAYtS2o_gyS5W24UOaVgf8,2774
+markdown_merge-0.1.8.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+markdown_merge-0.1.8.dist-info/entry_points.txt,sha256=jTaJtzTxHp7dbtuWOitXxilSKAgFXX-m6e_paLdbr70,50
+markdown_merge-0.1.8.dist-info/top_level.txt,sha256=036ta8zjflvmW-hSc9kB-VSyF5UylMCOGjTC_EN3frU,15
+markdown_merge-0.1.8.dist-info/RECORD,,

markdown_merge-0.1.8.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

markdown_merge-0.1.8.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[nbdev]
+markdown_merge = markdown_merge._modidx:d

markdown_merge-0.1.8.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

markdown_merge-0.1.8.dist-info/top_level.txt

@@ -0,0 +1 @@
+markdown_merge