Change name of the project

Author: drkostas

Makefile

@@ -14,7 +14,7 @@ ifeq ($(env),venv)
 	DEACTIVATE_COMMAND="deactivate"
 else
 	# Use Conda
-	BASE=~/anaconda3/envs/py_emailer
+	BASE=~/anaconda3/envs/pyemail_sender
 	BIN=$(BASE)/bin
 	CREATE_COMMAND="conda create --prefix $(BASE) python=$(PYTHON_VERSION) -y"
 	DELETE_COMMAND="conda env remove -p $(BASE)"

README.md

@@ -1,12 +1,12 @@
 # Python Emailer
 
-[![CircleCI](https://circleci.com/gh/drkostas/py-emailer/tree/master.svg?style=svg)](https://circleci.com/gh/drkostas/py-emailer/tree/master)
-[![GitHub license](https://img.shields.io/badge/license-Apache-blue.svg)](https://github.com/drkostas/py-emailer/master/LICENSE)
+[![CircleCI](https://circleci.com/gh/drkostas/pyemail-sender/tree/master.svg?style=svg)](https://circleci.com/gh/drkostas/pyemail-sender/tree/master)
+[![GitHub license](https://img.shields.io/badge/license-Apache-blue.svg)](https://github.com/drkostas/pyemail-sender/master/LICENSE)
 
 ## About <a name = "about"></a>
 
 A utility for sending emails with attachments. Currently only Gmail 
-is supported. [PYPI Package](https://pypi.org/project/py-emailer/)
+is supported. [PYPI Package](https://pypi.org/project/pyemail-sender/)
 
 ## Table of Contents
 
@@ -24,7 +24,7 @@ is supported. [PYPI Package](https://pypi.org/project/py-emailer/)
 ## Using the library <a name = "using"></a>
 
 For a detailed usage example see 
-[example.py](https://github.com/drkostas/py-emailer/master/example.py).
+[example.py](https://github.com/drkostas/pyemail-sender/master/example.py).
 
 You will need an application-specific password for your Google account. 
 [Reference 1](https://support.google.com/mail/?p=InvalidSecondFactor), 
@@ -35,31 +35,31 @@ You will need an application-specific password for your Google account.
 First, you need to install the library using pip:
 
 ```shell
-$ pip install py_emailer
+$ pip install pyemail_sender
 ```
 
 Then, import it and initialize it like so:
 
 ```python
-from py_emailer import GmailPyEmailer
+from pyemail_sender import GmailPyEmailSender
 
 email_conf = {'type': 'gmail',
               'config': {'api_key': 'your api key', 'email_address': 'youremail@gmail.com'}}
-pymail = GmailPyEmailer(config=email_conf)
+pymail = GmailPyEmailSender(config=email_conf)
 ```
 
-If you want to use a yml file to load the configuration, you can use the `PyEmailerConfig` class:
+If you want to use a yml file to load the configuration, you can use the `PyEmailSenderConfig` class:
 ```python
-from py_emailer import PyEmailerConfig
+from pyemail_sender import PyEmailSenderConfig
 import os
 
 config_path = str(os.path.join('confs', 'conf.yml'))
-config = PyEmailerConfig(config_src=config_path)
-email_conf = config.get_pyemailer_config()
+config = PyEmailSenderConfig(config_src=config_path)
+email_conf = config.get_pyemail_sender_config()
 ```
 
 Two example YAML files can be found in 
-the [confs folder](https://github.com/drkostas/py-emailer/blob/master/confs).
+the [confs folder](https://github.com/drkostas/pyemail-sender/blob/master/confs).
 For more details on how to use this YAML configuration loader see 
 this [Readme](https://github.com/drkostas/yaml-config-wrapper/blob/master/README.md).
 
@@ -91,7 +91,7 @@ pymail.send_email(subject='Email with all possible arguments',
 ```
 
 All of these examples can be found 
-in [example.py](https://github.com/drkostas/py-emailer/tree/blob/master/example.py).
+in [example.py](https://github.com/drkostas/pyemail-sender/tree/blob/master/example.py).
 
 ## Manually install the library <a name = "manual_install"></a>
 
@@ -117,16 +117,16 @@ $ echo $SHELL
 ### Install the requirements <a name = "installing_req"></a>
 
 All the installation steps are being handled by
-the [Makefile](https://github.com/drkostas/py-emailer/blob/master/Makefile).
+the [Makefile](https://github.com/drkostas/pyemail-sender/blob/master/Makefile).
 
 First, modify the python version (`min_python`) and everything else you need in
-the [settings.ini](https://github.com/drkostas/py-emailer/blob/master/settings.ini).
+the [settings.ini](https://github.com/drkostas/pyemail-sender/blob/master/settings.ini).
 
 Then, execute the following commands:
 
 ```ShellSession
 $ make create_env
-$ conda activate py_emailer
+$ conda activate pyemail_sender
 $ make dist
 ```
 
@@ -146,7 +146,7 @@ For the continuous integration, the <b>CircleCI</b> service is being used. For m
 check the [setup guide](https://circleci.com/docs/2.0/language-python/).
 
 For any modifications, edit
-the [circleci config](https://github.com/drkostas/py-emailer/blob/master/.circleci/config.yml).
+the [circleci config](https://github.com/drkostas/pyemail-sender/blob/master/.circleci/config.yml).
 
 ## Update PyPI package <a name = "pypi"></a>
 
@@ -161,13 +161,13 @@ password = your_pypi_password
 
 Then, modify the python version (`min_python`), project status (`status`), release version (`version`) 
 and everything else you need in
-the [settings.ini](https://github.com/drkostas/py-emailer/blob/master/settings.ini).
+the [settings.ini](https://github.com/drkostas/pyemail-sender/blob/master/settings.ini).
 
 Finally, execute the following commands:
 
 ```ShellSession
 $ make create_env
-$ conda activate py_emailer
+$ conda activate pyemail_sender
 $ make release
 ```
 
@@ -176,6 +176,6 @@ For a dev release, change the `testing_version` and instead of `make release`, r
 ## License <a name = "license"></a>
 
 This project is licensed under the MIT License - see
-the [LICENSE](https://github.com/drkostas/py-emailer/blob/master/LICENSE) file for details.
+the [LICENSE](https://github.com/drkostas/pyemail-sender/blob/master/LICENSE) file for details.
 
 <a href="https://www.buymeacoffee.com/drkostas" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>

confs/conf.yml

@@ -1,5 +1,5 @@
 tag: test
-py-emailer:
+pyemail-sender:
   - config:
       email_address: Your Name <youremail@gmail.com>
       api_key: your-api-key

confs/conf_with_env_vars.yml

@@ -1,5 +1,5 @@
 tag: test
-py-emailer:
+pyemail-sender:
   - config:
       email_address: !ENV ${EMAIL_ADDRESS}
       api_key: !ENV ${GMAIL_API_KEY}

env_example

@@ -1,3 +1,3 @@
 # You should create a new file with ".env" name or something similar and NOT include it in your git
-export EMAIL_ADDRESS="Your Name <youremail@gmail.com>"
+export EMAIL_ADDRESS=Your Name <youremail@gmail.com>
 export GMAIL_API_KEY=your-api-key

example.py

@@ -1,6 +1,6 @@
-# pip install py-emailer
+# pip install pyemail-sender
 import os
-from py_emailer import GmailPyEmailer, PyEmailerConfig, ColorLogger
+from pyemail_sender import GmailPyEmailSender, PyEmailSenderConfig, ColorLogger
 
 # Setup Logger
 log = ColorLogger(logger_name='Example', color='yellow')
@@ -10,15 +10,15 @@
 #               'config': {'api_key': 'your api key', 'email_address': 'youremail@gmail.com'}}
 # config_path = os.path.join('confs', 'conf.yml')
 config_path = os.path.join('confs', 'conf_with_env_vars.yml')
-config = PyEmailerConfig(config_src=config_path)
-email_conf = config.get_pyemailer_config()
+config = PyEmailSenderConfig(config_src=config_path)
+email_conf = config.get_pyemail_sender_config()
 # Check for errors
 if email_conf['type'] != 'gmail':
     raise Exception(f"{email_conf['type']} not yet supported!")
 if email_conf['config']['api_key'] == 'GMAIL_API_KEY':
     raise Exception("You are trying to use environmental variables but they are not loaded!")
 # Initialize handler
-pymail = GmailPyEmailer(config=email_conf['config'])
+pymail = GmailPyEmailSender(config=email_conf['config'])
 # Create a test file
 with open('my_file.txt', 'w') as fp:
     fp.write('blank')

py_emailer/__init__.py

@@ -0,0 +1,9 @@
+"""pyemail-sender package"""
+
+from .gmail_pyemail_sender import GmailPyEmailSender
+from .pyemail_sender_config import PyEmailSenderConfig
+from termcolor_logger import ColorLogger
+
+__author__ = "drkostas"
+__email__ = "georgiou.kostas94@gmail.com"
+__version__ = "1.0.1"

pyemail_sender/__init__.py

@@ -1,7 +1,7 @@
 from abc import ABC, abstractmethod
 
 
-class AbstractPyEmailer(ABC):
+class AbstractPyEmailSender(ABC):
     __slots__ = ('_handler',)
 
     @abstractmethod
@@ -17,7 +17,7 @@ def __init__(self, *args, **kwargs) -> None:
     @abstractmethod
     def get_handler(*args, **kwargs):
         """
-        Returns an PyEmailer handler.
+        Returns an PyEmailSender handler.
 
         :param args:
         :param kwargs:

py_emailer/abstract_pyemailer.py renamed to pyemail_sender/abstract_pyemail_sender.py

@@ -1,12 +1,12 @@
 from typing import List, Dict
 from gmail import GMail, Message
 from termcolor_logger import ColorLogger
-from .abstract_pyemailer import AbstractPyEmailer
+from .abstract_pyemail_sender import AbstractPyEmailSender
 
-logger = ColorLogger('GmailPyEmailer')
+logger = ColorLogger('GmailPyEmailSender')
 
 
-class GmailPyEmailer(AbstractPyEmailer):
+class GmailPyEmailSender(AbstractPyEmailSender):
     __slots__ = ('_handler', 'email_address', 'test_mode')
 
     _handler: GMail