Client Mailer

CRM & client Mail system

A project to manage a list of clients which can then be emailed from a selection of email templates. This is controlled through a CLI menu.

Preview

Table of Contents

• Project Title
• Preview
• Installation
• Data
• Code
• Tests
• Conclusion

Installation

1. Start by cloning the repository:

git clone https://github.com/ChristopherBacon/Client-Mailer.git
cd ClientMailer'

2. Create a python 3.7.3 environment.

3. Install dependencies

pip install requirements.txt

4. To run tests in terminal:

cd ClientMailer
pytest

Data

1. emails/ This is where the templates for the emails live. You can add templates to this manually as txt files.

2. clients.csvDictionary of pre-existing clients that can be uploaded and mailed.

Code

1. clients.py Contains the client class for creating clients, and also client helper functions for uploading clients.

2. mailer.py The mail server for the project. You can run in debug mode: python -m smtpd -c DebuggingServer -n localhost:1025 then test your mail sending.

3. mailtemplates.py Helper functions for checking emails and personalising for clients.

4. menu.py The main CLI menu, allowing you access all options and send mail. See screenshot for options.

Tests

1. test_clients.py Tests the client class and functions.

2. test_mailer.py Still using debug server, more work to be done here.

3. test_mailtemplates.py Testing the email templates to see if they work and are in order.

Conclusion

This is an ongoing project that I will be adding to and expanding. Really enjoyed working on it and I learnt alot. This was the first time that I had used tests in my development so will expand on that as well in future.