diqu-email


Namediqu-email JSON
Version 1.0.0 PyPI version JSON
download
home_pagehttps://datnguyen.de
SummaryData Quality CLI for the Auto-Alerts - Emails
upload_time2024-07-07 04:06:59
maintainerNone
docs_urlNone
authorDat Nguyen
requires_python<3.13,>=3.9
licenseMIT
keywords packaging poetry data-quality alert notification collaboration agility flake8 markdown lint
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # diqu-email

Alert module using Email method (Sendgrid)

## How to use

### Installation

```bash
pip install diqu diqu-email
```

### Send email

Before you can send email with Sendgrid, go create your template first:

- Go to Email API / Dynamic Templates: Create a Dyanmic Template
- Design your template e.g.

    ![sample template](/example/image.png)
- Save it and get the Template ID e.g. `d-c70732f1cb304d39823d52cd5cee8312`
- Go to Settings / API Keys: Get an API key e.g. SG.xxx.xxx

Now, you're ready to send alert:

```bash
export SENDGRID_API_KEY=YOURVALUE e.g. SG.xxx.xxx
export SENDGRID_MAILING_LIST=YOURVALUE e.g. dat@domain.com,dat2@domain.com
export SENDGRID_TEMPLATE_ID=YOURVALUE e.g. d-c70732f1cb304d39823d52cd5cee8312

# powershell
$env:SENDGRID_API_KEY="YOURVALUE"
$env:SENDGRID_MAILING_LIST="dat@domain.com,dat2@domain.com"
$env:SENDGRID_TEMPLATE_ID="d-c70732f1cb304d39823d52cd5cee8312"

diqu alert --to sendgrid
```

For a quick testing purpose, we can use the CSV package to run the [example](./example/) as following command:

```bash
diqu alert --to sendgrid --package csv --profile-name example --profiles-dir ./example
```

Here is the sample result:

![Alt text](/example/email.png)

Raw data

            {
    "_id": null,
    "home_page": "https://datnguyen.de",
    "name": "diqu-email",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.13,>=3.9",
    "maintainer_email": null,
    "keywords": "packaging, poetry, data-quality, alert, notification, collaboration, agility, flake8, markdown, lint",
    "author": "Dat Nguyen",
    "author_email": "datnguyen.it09@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/eb/91/6524eaefcffb84d3bab38391bcb08ec1d5721f63ebffa27849e6a4e3e33f/diqu_email-1.0.0.tar.gz",
    "platform": null,
    "description": "# diqu-email\n\nAlert module using Email method (Sendgrid)\n\n## How to use\n\n### Installation\n\n```bash\npip install diqu diqu-email\n```\n\n### Send email\n\nBefore you can send email with Sendgrid, go create your template first:\n\n- Go to Email API / Dynamic Templates: Create a Dyanmic Template\n- Design your template e.g.\n\n    ![sample template](/example/image.png)\n- Save it and get the Template ID e.g. `d-c70732f1cb304d39823d52cd5cee8312`\n- Go to Settings / API Keys: Get an API key e.g. SG.xxx.xxx\n\nNow, you're ready to send alert:\n\n```bash\nexport SENDGRID_API_KEY=YOURVALUE e.g. SG.xxx.xxx\nexport SENDGRID_MAILING_LIST=YOURVALUE e.g. dat@domain.com,dat2@domain.com\nexport SENDGRID_TEMPLATE_ID=YOURVALUE e.g. d-c70732f1cb304d39823d52cd5cee8312\n\n# powershell\n$env:SENDGRID_API_KEY=\"YOURVALUE\"\n$env:SENDGRID_MAILING_LIST=\"dat@domain.com,dat2@domain.com\"\n$env:SENDGRID_TEMPLATE_ID=\"d-c70732f1cb304d39823d52cd5cee8312\"\n\ndiqu alert --to sendgrid\n```\n\nFor a quick testing purpose, we can use the CSV package to run the [example](./example/) as following command:\n\n```bash\ndiqu alert --to sendgrid --package csv --profile-name example --profiles-dir ./example\n```\n\nHere is the sample result:\n\n![Alt text](/example/email.png)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Data Quality CLI for the Auto-Alerts - Emails",
    "version": "1.0.0",
    "project_urls": {
        "Homepage": "https://datnguyen.de",
        "Repository": "https://github.com/infinitelambda/diqu-email"
    },
    "split_keywords": [
        "packaging",
        " poetry",
        " data-quality",
        " alert",
        " notification",
        " collaboration",
        " agility",
        " flake8",
        " markdown",
        " lint"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f541e8055d789792e7ec42ca384b8da11b437a53401f0c2640f3eca3e00e75c0",
                "md5": "4a7d8e222a3748df31a762c2f18c52e9",
                "sha256": "65936d5d5181c43711b0c0ae90a5b210cc4f91994b8fe26ae6cf764526d434da"
            },
            "downloads": -1,
            "filename": "diqu_email-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4a7d8e222a3748df31a762c2f18c52e9",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.13,>=3.9",
            "size": 4370,
            "upload_time": "2024-07-07T04:06:57",
            "upload_time_iso_8601": "2024-07-07T04:06:57.784378Z",
            "url": "https://files.pythonhosted.org/packages/f5/41/e8055d789792e7ec42ca384b8da11b437a53401f0c2640f3eca3e00e75c0/diqu_email-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "eb916524eaefcffb84d3bab38391bcb08ec1d5721f63ebffa27849e6a4e3e33f",
                "md5": "bcc8e600494f61b36cb9d8adbb826cda",
                "sha256": "a9c43c3fcbdfd39780182a4b646bbdd8f5a77cb4502d7c1ba90857c0c9ee1e98"
            },
            "downloads": -1,
            "filename": "diqu_email-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "bcc8e600494f61b36cb9d8adbb826cda",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.13,>=3.9",
            "size": 3492,
            "upload_time": "2024-07-07T04:06:59",
            "upload_time_iso_8601": "2024-07-07T04:06:59.092258Z",
            "url": "https://files.pythonhosted.org/packages/eb/91/6524eaefcffb84d3bab38391bcb08ec1d5721f63ebffa27849e6a4e3e33f/diqu_email-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-07 04:06:59",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "infinitelambda",
    "github_project": "diqu-email",
    "github_not_found": true,
    "lcname": "diqu-email"
}
Dat Nguyen
Elapsed time: 0.97575s