<p align="center">
  <img src="./assets/python-logo.svg" alt="Python" width="250"/>
</p>

<h1 align="center">CredVault Python SDK</h1>

<p align="center">
  <strong>The official Python client library for the CredVault Data Platform</strong>
</p>

<p align="center">
  <a href="https://pypi.org/project/credvault/"><img src="https://img.shields.io/pypi/v/credvault.svg" alt="PyPI version"/></a>
  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License: MIT"/></a>
  <a href="https://docs.credvault.io"><img src="https://img.shields.io/badge/docs-credvault.io-green.svg" alt="Documentation"/></a>
</p>

---

## Welcome

Thank you for choosing CredVault! This SDK is designed for Python developers who want to integrate with the CredVault Data Platform. It works seamlessly with scripts, web applications, and Jupyter notebooks.

## What You Can Do

With this SDK, you can:

- 🔐 **Authenticate Users** — Handle login, signup, and session management
- 📊 **Manage Data** — Query, insert, update, and delete from your database clusters
- 🤖 **Use AI Models** — Train and run predictions with the CredVault Intelligence Engine
- 🔗 **Configure Webhooks** — Get notified when events happen in your data
- ⚡ **Run Functions** — Execute serverless functions on your data
- 💾 **Handle Backups** — Create and restore database backups
- 📈 **Monitor Metrics** — Track performance and usage in real-time

## Getting Started

### Step 1: Install the Package

```bash
pip install credvault
```

### Step 2: Initialize the Client

```python
from credvault import CredVault

client = CredVault(api_key='your-api-key-here')
```

### Step 3: Start Building!

You're all set. Check out our [documentation](https://docs.credvault.io) for detailed guides and examples.

## Available Resources

| Resource | What It Does |
|----------|--------------|
| `auth` | Handle user authentication and profiles |
| `data` | Work with your database clusters and collections |
| `cie` | Access AI and machine learning capabilities |
| `webhooks` | Set up event notifications |
| `functions` | Deploy and run serverless functions |
| `triggers` | Create database event triggers |
| `backups` | Manage database backups |
| `schema` | Analyze schemas and manage indexes |
| `api_keys` | Create and manage API keys |
| `metrics` | View platform metrics and analytics |
| `logs` | Access activity logs |
| `notifications` | Manage notification preferences |
| `settings` | Configure account settings |

## Requirements

- **Python** 3.8 or higher
- **requests** library (installed automatically)

## Need Help?

We're here to support you:

- 📚 **Documentation**: [docs.credvault.io](https://docs.credvault.io)
- 💬 **Community**: [Discord](https://discord.gg/credvault)
- 📧 **Email**: support@credvault.io
- 🐛 **Issues**: [GitHub Issues](https://github.com/credvault/sdk-python/issues)

## License

This SDK is open source and available under the [MIT License](./LICENSE).

---

<p align="center">Made with ❤️ by the CredVault Team</p>
