Stable release 1.2.0

Added fill_value argument on aggregate function; this value also
is callable without arguments.
Added send method on Report class; with this method you send
report via email.
Added send method on ReportBook class; with this method you send
report via email.
Fix __str__ method on Report class.

Author: MatteoGuadrini

CHANGES.md

@@ -1,5 +1,13 @@
 # Release notes
 
+## 1.2.0
+Aug 5, 2021
+
+- Added _fill_value_ argument on **aggregate** function; this value also is callable without arguments
+- Added _send_ method on **Report** class; with this method you send report via email
+- Added _send_ method on **ReportBook** class; with this method you send report via email
+- Fix \*__str__* method on **Report** class
+
 ## 1.1.0
 Jun 5, 2021
 

__info__.py

@@ -22,7 +22,7 @@
 
 """Information variable used by modules on this package."""
 
-__version__ = '1.1.0'
+__version__ = '1.2.0'
 __author__ = 'Matteo Guadrini'
 __email__ = '[email protected]'
 __homepage__ = 'https://github.com/MatteoGuadrini/pyreports'

index.html

@@ -151,6 +151,7 @@ <h2 class="title">Features</h2>
                 <li><i class="fas fa-check"></i> All objects are extensible</li>
                 <li><i class="fas fa-check"></i> Functions that support data modification</li>
                 <li><i class="fas fa-check"></i> Data exports to Excel, CSV, YAML, Json and more.</li>
+                <li><i class="fas fa-check"></i> Send exported data to email</li>
             </ul>
         </div><!--//container-->
     </section><!--//features-->

pyreports/core.py

@@ -24,6 +24,12 @@
 
 # region Imports
 import tablib
+import smtplib
+import ssl
+from email.mime.text import MIMEText
+from email.mime.multipart import MIMEMultipart
+from email import encoders
+from email.mime.base import MIMEBase
 from .io import FileManager
 from .exception import ReportManagerError, ReportDataError
 
@@ -245,7 +251,7 @@ def __str__(self):
 
         :return: string
         """
-        return self._print_data()
+        return str(self._print_data())
 
     def _print_data(self):
         """Print data and count
@@ -295,6 +301,64 @@ def export(self):
         else:
             raise ReportManagerError('the output object must be FileManager or NoneType object')
 
+    def send(self, server, _from, to, cc=None, bcc=None, subject=None, body='', auth=None, _ssl=True, headers=None):
+        """Send saved report to email
+
+        :param server: server SMTP
+        :param _from: email address 'from:'
+        :param to: email address 'to:'
+        :param cc: email address 'cc:'
+        :param bcc: email address 'bcc:'
+        :param subject: email subject. Default is report title
+        :param body: email body
+        :param auth: authorization tuple "(user, password)"
+        :param _ssl: boolean, if True port is 465 else 25
+        :param headers: more header value "(header_name, key, value)"
+        :return: None
+        """
+        if not self.output:
+            raise ReportDataError('if you want send a mail with a report in attachment, must be specified output')
+
+        # Prepare mail header
+        message = MIMEMultipart("alternative")
+        message["Subject"] = self.title if not subject else subject
+        message["From"] = _from
+        message["To"] = to
+        if cc:
+            message["Cc"] = cc
+        if bcc:
+            message["Bcc"] = bcc
+        if headers:
+            message.add_header(*headers)
+
+        # Prepare body
+        part = MIMEText(body, "html")
+        message.attach(part)
+
+        # Prepare attachment
+        self.export()
+        attach_file_name = self.output.file
+        attach_file = open(attach_file_name, 'rb')
+        payload = MIMEBase('application', 'octate-stream')
+        payload.set_payload(attach_file.read())
+        encoders.encode_base64(payload)
+        payload.add_header('Content-Disposition', 'attachment', filename=attach_file_name)
+        message.attach(payload)
+
+        # Prepare SMTP connection
+        if _ssl:
+            port = smtplib.SMTP_SSL_PORT
+            protocol = smtplib.SMTP_SSL
+            kwargs = {'context': ssl.create_default_context()}
+        else:
+            port = smtplib.SMTP_PORT
+            protocol = smtplib.SMTP
+            kwargs = {}
+        with protocol(server, port, **kwargs) as srv:
+            if auth:
+                srv.login(*auth)
+            srv.sendmail(_from, to, message.as_string())
+
 
 class ReportBook:
 
@@ -395,4 +459,23 @@ def export(self, output=None):
             for report in self:
                 report.export()
 
+    def send(self, server, _from, to, cc=None, bcc=None, subject=None, body='', auth=None, _ssl=True, headers=None):
+        """Send saved report to email
+
+        :param server: server SMTP
+        :param _from: email address 'from:'
+        :param to: email address 'to:'
+        :param cc: email address 'cc:'
+        :param bcc: email address 'bcc:'
+        :param subject: email subject. Default is report title
+        :param body: email body
+        :param auth: authorization tuple "(user, password)"
+        :param _ssl: boolean, if True port is 465 else 25
+        :param headers: more header value "(header_name, key, value)"
+        :return: None
+        """
+        for report in self:
+            report.send(server, _from, to, cc=cc, bcc=bcc, subject=subject, body=body, auth=auth,
+                        _ssl=_ssl, headers=headers)
+
 # endregion

pyreports/datatools.py

@@ -109,12 +109,13 @@ def counter(data, column):
     return Counter((item for item in data))
 
 
-def aggregate(*columns, fill_empty: bool = False):
+def aggregate(*columns, fill_empty: bool = False, fill_value=None):
     """
     Aggregate in a new Dataset the columns
 
     :param columns: columns added
-    :param fill_empty: fill the empty field of data with None
+    :param fill_empty: fill the empty field of data with "fill_value" argument
+    :param fill_value: fill value for empty field if "fill_empty" argument is specified
     :return: Dataset
     """
     if len(columns) >= 2:
@@ -124,7 +125,7 @@ def aggregate(*columns, fill_empty: bool = False):
         for list_ in columns[1:]:
             if fill_empty:
                 while len(last_list) != len(list_):
-                    list_.append(None)
+                    list_.append(fill_value() if callable(fill_value) else fill_value)
             else:
                 if len(last_list) != len(list_):
                     raise InvalidDimensions('the columns are not the same length')