Metadata-Version: 2.4
Name: pattan-sendgrid
Version: 2.2.0
Summary: Manage Sendgrid assets
Author-email: Markus Weltin <mweltin@pattan.net>, Don Rea <drea@pattan.net>
Maintainer-email: Don Rea <drea@pattan.net>
Project-URL: Homepage, https://github.com/pattan-net/pattan-email
Project-URL: Documentation, https://github.com/pattan-net/pattan-email/docs
Keywords: pattan,sendgrid
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: sendgrid>=6.10.0
Requires-Dist: pydantic>=2.11.4
Requires-Dist: click>=8.2.0
Dynamic: license-file

# pattan-sendgrid

**pattan-sendgrid** is a Python package that wraps the **sendgrid** package
with PaTTAN-specific configurations.

## Quick start
1. Installation (bash):  
    `pip install pattan-sendgrid`
2. Create an environment variable **SENDGRID_API_KEY** and set its value to your SendGrid API key:  
    `export SENDGRID_API_KEY={your SENDGRID_API_KEY}`
3. Generate the config the package uses by redirecting the output of the **gc** command to a file or copy/paste to a file.  Keep this file out of version control as it will include your SendGrid API key (bash):  
    `pe gc >{your filename}`  
    If you are using Django, the project's **.env** is a good place for this value.
4. Use the output from the command in step **3** to initialize the **PattanEmail** class (bash): 
    ```bash
    from pattan_sendgrid import PattanEmail
     ...
    emailer = PattanEmail({command output from step 3})
   ```

## Resources
1. https://docs.djangoproject.com/en/5.0/intro/reusable-apps/
2. https://pypi.org/project/sendgrid/


