semvec/pypi-packages huggingface dataset:
pydatamail 0.0.10
pydatamail - a python module to apply data science principles to email processing
License: BSD

# Manage your emails with Python 
[![Python package](https://github.com/pyscioffice/pydatamail/actions/workflows/unittest.yml/badge.svg?branch=main)](https://github.com/pyscioffice/pydatamail/actions/workflows/unittest.yml)
[![Coverage Status](https://coveralls.io/repos/github/pyscioffice/pydatamail/badge.svg?branch=main)](https://coveralls.io/github/pyscioffice/pydatamail?branch=main)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

The `pydatamail` is a python module to apply data science principles to email processing. It stores the emails in an 
`SQL` database and generates `pandas.DataFrame` objects for futher processing and plotting.

# Installation 
Install the `pydatamail` package using `pip`:
```
pip install pydatamail
```
Or alternatively using `conda`: 
```
conda install -c conda-forge pydatamail
```

# Python interface 
Import the `pygmailfiler` module 
```
from pydatamail DatabaseInterface, get_from_pie_plot, get_labels_pie_plot, get_number_of_email_plot, Message, email_date_converter
```

The individual components are briefly explained below: 

* `DatabaseInterface` - `SQLalchemy` based interface for `SQL` database to store emails
* `get_from_pie_plot` - plot a pie chart of the distribution of emails senders
* `get_labels_pie_plot` - plot a pie chart of the distribution of email labels
* `get_number_of_email_plot` - plot the number of incoming emails over time
* `Message` - abstract class to implement `pydatamail` compatible email adapters
* `email_date_converter` - convert the email date to python `datetime` dates.