Metadata-Version: 2.4
Name: emailguard_sdk
Version: 1.2.0
Summary: EmailGuard public API Python SDK
Home-page: https://github.com/EmailGuard/emailguard-python
Author: EmailGuard
Author-email: EmailGuard <dev@emailguard.co>
License-Expression: MIT
Project-URL: Repository, https://github.com/EmailGuard/emailguard-python
Keywords: emailguard,api,sdk
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: urllib3<3.0.0,>=2.1.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2.11
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-python

# emailguard-sdk

Python SDK for the EmailGuard public API. This package is generated from the public OpenAPI spec.

## Links

- [EmailGuard website](https://emailguard.co)
- [API docs](https://emailguard.co/docs/api-reference)
- [Python SDK guide](https://emailguard.co/docs/api-reference/guides/sdk-python)
- [OpenAPI spec](https://api.emailguard.co/api/v1/openapi.json)
- [Developer support](mailto:dev@emailguard.co)

## Install

```bash
pip install emailguard-sdk
```

## Authentication

Create a team-scoped API key in EmailGuard, then authenticate requests with:

```bash
Authorization: Bearer egsk_live_...
```

For local examples, you can also set:

```bash
EMAILGUARD_API_KEY=egsk_live_...
```

## Usage

```python
from emailguard_sdk import EmailGuard

client = EmailGuard(api_key=os.environ["EMAILGUARD_API_KEY"])
```

## Examples

See the generated [`examples/`](./examples/) directory for runnable workflows.


## API Responses

REST API responses use a JSON envelope:

```json
{ "code": "SUCCESS", "data": {}, "message": "" }
```

The public client unwraps `data` on success and raises/returns `APIError` for unsuccessful envelopes. Generated low-level transports remain available for advanced use.

## Related Packages

- [@emailguard/sdk (TypeScript)](https://www.npmjs.com/package/@emailguard/sdk)
- [@emailguard/mcp (MCP)](https://www.npmjs.com/package/@emailguard/mcp)
- [github.com/EmailGuard/emailguard-go (Go)](https://pkg.go.dev/github.com/EmailGuard/emailguard-go)
- [emailguard-sdk (Python)](https://pypi.org/project/emailguard-sdk/) (this package)
- [emailguard/emailguard-sdk (PHP)](https://packagist.org/packages/emailguard/emailguard-sdk)
- [emailguard_sdk (Ruby)](https://rubygems.org/gems/emailguard_sdk)
- [EmailGuard Zapier integration](https://emailguard.co/docs/api-reference/guides/getting-started)

## Support

Questions, issues, or feedback? Email [dev@emailguard.co](mailto:dev@emailguard.co).

## License

MIT
