automail to pyautomail

docs/getting-started.rst

@@ -1,4 +1,4 @@
-Quickstart with automail
+Quickstart with pyautomail
 =============================
 
 Welcome to automail! This guide will help you get up and running with the automated
@@ -26,8 +26,14 @@ Python 3.9 or higher.
 
 Installation
 ------------
+To install pyautomail, you can use pip to install the package directly from PyPI:
 
-To install automail, you can use pip and git to install the package directly from GitHub:
+.. code-block:: bash
+
+    $ pip install pyautomail
+
+
+Or you can use pip and git to install the latest version directly from GitHub:
 
 .. code-block:: bash
 
@@ -48,7 +54,7 @@ Alternatively, you can clone the repository and install the package from source:
 
 How to Use
 ----------
-There are two ways to use automail to send emails. You can either use the most powerful
+There are two ways to use pyautomail to send emails. You can either use the most powerful
 command-line interface (CLI) tool without writing any Python code, or you can use the
 Python package in your custom scripts. We'll cover a quick overview of both of these
 options in this guide. For more details, please refer to :doc:`the Tutorial section <tutorial/index>`
@@ -59,7 +65,7 @@ and the :doc:`API reference <api/index>`.
 1. Automail command-line interface (CLI) tool
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-When you install automail, you will also get a command-line interface (CLI) tool called `automail`.
+When you install pyautomail, you will also get a command-line interface (CLI) tool called `automail`.
 This tool can be used to send emails from the command line, without writing any Python code.
 So if you want to send a quick email without writing a script, you can use the CLI tool.
 
@@ -120,7 +126,7 @@ This will give you more flexibility and control over the email sending process.
 You can use the Python package to send emails to multiple recipients, use custom email templates,
 and customize other settings according to your needs.
 
-You can also use automail in your custom Python scripts to send emails.
+You can also use pyautomail in your custom Python scripts to send emails.
 Here's two basic examples of sending an email to a single recipient:
 
 - **First example**

docs/index.rst

@@ -1,9 +1,9 @@
-.. Automail documentation master file, created by
+.. Pyautomail documentation master file, created by
    sphinx-quickstart on Tue Jul 25 17:21:33 2023.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-**AUTOMAIL: Automated Email Sending for Large Scale Email and Gmail Automation**
+**PYAUTOMAIL: Automated Email Sending for Large Scale Email and Gmail Automation**
 ================================================================================
 
 .. figure:: _static/automail-logo.png
@@ -15,37 +15,35 @@
 
    <br>
 
-
-Welcome to the documentation for **automail**, a powerful Python package designed
+Welcome to the documentation for **pyautomail**, a powerful Python package designed
 for automated email sending, especially tailored for large scale Email or Gmail automation.
 In today's fast-paced digital world, effective communication is a vital aspect of many
 businesses and projects which rely on email as a primary means of communication.
 However, manually sending individual emails or even managing bulk
 email campaigns can be time-consuming and error-prone.
 
-**Automail** comes to the rescue by providing a seamless and efficient solution for
+**Pyautomail** comes to the rescue by providing a seamless and efficient solution for
 automating email communication. Whether you need to send personalized emails to
 a vast audience, conduct email marketing campaigns, or automate routine email
 tasks, this package is your go-to tool. Its user-friendly interface
 and versatile features make it suitable for a wide range of applications, from
 startups to enterprises, professionals, and developers.
 
 Whether you need to send bulk emails, automate Gmail tasks, or
-improve your email communication efficiency, **automail** is here to streamline
+improve your email communication efficiency, **PYautomail** is here to streamline
 your workflow and enhance productivity.
 
 .. note::
-   For more information about **automail**
+   For more information about **pyautomail**
    and its capabilities, please explore our documentation.
 
-   - You can see a short overview and features of ``automail`` in the :doc:`Introduction <introduction>` section.
-   - If you are new to ``automail``, you can get started with our :doc:`Getting Started <getting-started>` guide.
+   - You can see a short overview and features of ``pyautomail`` in the :doc:`Introduction <introduction>` section.
+   - If you are new to ``pyautomail``, you can get started with our :doc:`Getting Started <getting-started>` guide.
    - For a quick reference, you can check out the :doc:`API Reference <api/index>` section.
-   - If you want to learn more about ``automail`` and best practices, you can read our :doc:`Tutorial <tutorial/index>` section.
+   - If you want to learn more about ``pyautomail`` and best practices, you can read our :doc:`Tutorial <tutorial/index>` section.
 
 The documentation is organized into the following sections:
 
-
 .. toctree::
    :maxdepth: 2
    :caption: Contents
@@ -55,63 +53,4 @@ The documentation is organized into the following sections:
    tutorial/index
    api/index
 
-
-
 **Keywords**: Email, Gmail, Automation, Large Scale Email Sending, Python Package, Bulk Email, Email Automation, Email Automation Python, Gmail Integration, Automated Email Communication, Email Automation Tool, Mass Email Sending, Python Email Automation.
-
-
-
-1. **Introduction**
-
-   - Overview
-   - Features
-   - Installation
-
-2. **Getting Started**
-
-   - Quickstart Guide
-   - Configuration
-
-3. **Sending Emails**
-
-   - Single Recipient
-   - Multiple Recipients
-   - Customizing Templates
-
-4. **Gmail Automation**
-
-   - Setting Up Gmail Integration
-   - Managing Labels
-   - Searching and Filtering Emails
-
-5. **Advanced Usage**
-
-   - Email Attachments
-   - Error Handling
-   - Throttling and Rate Limiting
-
-6. **Best Practices**
-
-   - Bulk Email Tips
-   - Avoiding Spam Filters
-   - Performance Optimization
-
-7. **FAQs**
-
-   - Frequently Asked Questions
-
-8. **API Reference**
-
-   - automail Module
-
-9. **Contributing**
-
-   - How to Contribute
-   - Code Guidelines
-   - Issue Tracker
-
-10. **Changelog**
-
-    - Version History
-
-

docs/introduction.rst

@@ -4,52 +4,50 @@ Introduction
 Overview
 --------
 
-Automail is a dynamic Python package that enhances automated email sending.
+Pyautomail is a dynamic Python package that enhances automated email sending.
 Utilizing the built-in smtplib module, it ensures reliable communication.
 With the flexibility to send personalized emails using HTML or plain text templates,
-Automail adds a personal touch to each message. Boosted by Jinja2, it enables the
+Pyautomail adds a personal touch to each message. Boosted by Jinja2, it enables the
 creation of captivating and visually appealing email templates. Moreover, you can
 effortlessly attach global or personalized PDF files to enrich your emails.
 The package also offers the convenience of scheduling emails for timely delivery.
-Simplify your email campaigns and elevate your communication with **Automail**'s creative features and efficiency.
+Simplify your email campaigns and elevate your communication with **Pyautomail**'s creative features and efficiency.
 
 .. warning::
 
-   Automail is currently in alpha. It is not yet ready for production use.
+   Pyautomail is currently in alpha. It is not yet ready for production use.
 
 Key Features
 ------------
 - **Automated Email Sending**:
-    Automail enables you to automate the entire email sending process, saving
+    Pyautomail enables you to automate the entire email sending process, saving
     you valuable time and effort. With just a few lines of code, you can send
     personalized emails to individuals or even conduct large-scale email campaigns.
 
 - **Customizable Email Templates**:
-    Personalization is key to effective communication. With automail, you can
+    Personalization is key to effective communication. With pyautomail, you can
     create dynamic email templates using Jinja2 or simple HTML, allowing you to
     tailor each email's content to suit the recipient.
 
 - **Attachment Support**:
-    Want to include additional content with your emails? Automail makes it easy
+    Want to include additional content with your emails? Pyautomail makes it easy
     to attach global PDFs or personalized PDFs to each email, providing a seamless
     experience for your recipients.
 
 - **HTML or Plain Text**:
     Whether you prefer richly formatted HTML emails or simple plain text messages,
-    automail caters to your needs. The package supports both HTML (Jinja2 or standard)
+    pyautomail caters to your needs. The package supports both HTML (Jinja2 or standard)
     and plain text templates for versatile email communication.
 
 - **Scheduled Emails**:
-    Need to send emails at specific times? Automail allows you to schedule your
+    Need to send emails at specific times? Pyautomail allows you to schedule your
     emails for future delivery, ensuring your messages reach recipients at the
     most opportune moments.
 
-Whether you're a marketer, developer, or business owner, automail is a valuable addition
+Whether you're a marketer, developer, or business owner, pyautomail is a valuable addition
 to your toolkit. Experience the ease of automated email communication while reaching a
 wider audience and driving your projects towards success. So if you're ready to start
-see the :doc:`Getting Started <getting-started>` to learn how to use automail.
-
-
+see the :doc:`Getting Started <getting-started>` to learn how to use pyautomail.
 
 .. note::
 
@@ -59,8 +57,8 @@ see the :doc:`Getting Started <getting-started>` to learn how to use automail.
 
 Github
 ------
-The source code for automail is available on GitHub at the following link:
+The source code for pyautomail is available on GitHub at the following link:
 
 https://github.com/msinamsina/automail.git
 
-Please see the :ref:`how to use <how to use>` for a quick introduction on how to use Automail.
+Please see the :ref:`how to use <how to use>` for a quick introduction on how to use Pyautomail.

docs/tutorial/index.rst

@@ -1,11 +1,40 @@
-Tutorials
+Tutorial
+========
+
+.. note::
+   To install automail please see :ref:`installation <installation>`
+
+Base usage
 ==========
 
-In this section, we will go through some tutorials to show how to use the
-``automail`` package, and ``automail``'s command line interface.
+Below is a Python script that demonstrates how to send a single email:
+
+
+.. literalinclude:: ../../examples/base-usage.py
+   :language: python
+   :end-before: Creating a sender object
+
+
+.. literalinclude:: ../../examples/base-usage.py
+   :language: python
+   :start-after: Creating a sender object
+   :end-before: Set the template
+
+CLI Usage
+---------
+
+.. note::
+   After installation, you can use the command line tool ``automail`` to send emails.
+
+For sending emails, you need to do the following steps:
+
+- register a new process
+   .. code-block:: bash
+
+      $ automail register your-email-address path-to-your-contact-list
 
-There is different sample code and data for each tutorial. The code is
-available in the ``automail/tutorials`` directory of the source code
+   this command will return a process-id, which you will use to start the process.
+- start the process
+   .. code-block:: bash
 
-.. toctree::
-    tutorial
+      $ automail start process-id