Skip to content

Commit 95c9f6e

Browse files
Merge pull request #17 from Devotel/feature/rebrand-to-devhub
Rebrand to DevHub
2 parents 1a3af7e + 0af6407 commit 95c9f6e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+148
-161
lines changed

.github/workflows/test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ jobs:
4848
4949
- name: Test with pytest
5050
run: |
51-
pytest --cov=src/devo_global_comms_python --cov-report=xml --cov-report=html
51+
pytest --cov=src/devhub_python --cov-report=xml --cov-report=html
5252
5353
- name: Upload coverage to Codecov
5454
uses: codecov/codecov-action@v3

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# Devo Global Communications Python SDK
1+
# DevHub Python SDK
22

3-
[![PyPI version](https://badge.fury.io/py/devo-global-comms-python.svg)](https://badge.fury.io/py/devo-global-comms-python)
4-
[![Python Support](https://img.shields.io/pypi/pyversions/devo-global-comms-python.svg)](https://pypi.org/project/devo-global-comms-python/)
5-
[![Documentation](https://img.shields.io/badge/docs-github%20pages-blue)](https://devotel.github.io/devo-global-comms-python/)
3+
[![PyPI version](https://badge.fury.io/py/devhub-python.svg)](https://badge.fury.io/py/devhub-python)
4+
[![Python Support](https://img.shields.io/pypi/pyversions/devhub-python.svg)](https://pypi.org/project/devhub-python/)
5+
[![Documentation](https://img.shields.io/badge/docs-github%20pages-blue)](https://devotel.github.io/devhub-python/)
66
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
77

8-
A Python SDK for the Devo Global Communications API, supporting SMS, Email, WhatsApp, RCS, and Contact management.
8+
A Python SDK for the DevHub API, supporting SMS, Email, WhatsApp, RCS, and Contact management.
99

1010
## Features
1111

@@ -20,13 +20,13 @@ A Python SDK for the Devo Global Communications API, supporting SMS, Email, What
2020
## Installation
2121

2222
```bash
23-
pip install devo-global-comms-python
23+
pip install devhub-python
2424
```
2525

2626
## Quick Start
2727

2828
```python
29-
from devo_global_comms_python import DevoClient
29+
from devhub_python import DevoClient
3030

3131
# Initialize the client
3232
client = DevoClient(api_key="your-api-key")
@@ -61,7 +61,7 @@ print(f"WhatsApp message sent with ID: {whatsapp_response.id}")
6161
The SDK uses API key authentication:
6262

6363
```python
64-
from devo_global_comms_python import DevoClient
64+
from devhub_python import DevoClient
6565

6666
client = DevoClient(api_key="your-api-key")
6767
```
@@ -83,7 +83,7 @@ You can provide your own `requests.Session` for advanced configuration:
8383

8484
```python
8585
import requests
86-
from devo_global_comms_python import DevoClient
86+
from devhub_python import DevoClient
8787

8888
session = requests.Session()
8989
session.proxies = {"https": "https://proxy.example.com:8080"}
@@ -119,8 +119,8 @@ print(f"Status: {sms_response.status}")
119119

120120
```bash
121121
# Clone the repository
122-
git clone https://github.com/devotel/devo-global-comms-python.git
123-
cd devo-global-comms-python
122+
git clone https://github.com/devotel/devhub-python.git
123+
cd devhub-python
124124

125125
# Install development dependencies
126126
pip install -e ".[dev]"
@@ -136,7 +136,7 @@ pre-commit install
136136
pytest
137137

138138
# Run with coverage
139-
pytest --cov=src/devo_global_comms_python
139+
pytest --cov=src/devhub_python
140140

141141
# Run specific test file
142142
pytest tests/test_sms.py
@@ -171,8 +171,8 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
171171

172172
## Support
173173

174-
- **Documentation**: [https://devotel.github.io/devo-global-comms-python/](https://devotel.github.io/devo-global-comms-python/)
175-
- **Issues**: [GitHub Issues](https://github.com/devotel/devo-global-comms-python/issues)
174+
- **Documentation**: [https://devotel.github.io/devhub-python/](https://devotel.github.io/devhub-python/)
175+
- **Issues**: [GitHub Issues](https://github.com/devotel/devhub-python/issues)
176176
- **Email**: [support@devotel.io](mailto:support@devotel.io)
177177

178178
## Changelog

docs/error_handling.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Error Handling
22

3-
The Devo SDK provides comprehensive error handling to help you build robust applications.
3+
The DevHub SDK provides comprehensive error handling to help you build robust applications.
44

55
## Exception Types
66

77
The SDK uses a hierarchy of exceptions for different error scenarios:
88

99
```python
10-
from devo_global_comms_python.exceptions import DevoException
10+
from devhub_python.exceptions import DevoException
1111
```
1212

1313
All SDK exceptions inherit from `DevoException`, making it easy to catch any SDK-related error.
@@ -17,7 +17,7 @@ All SDK exceptions inherit from `DevoException`, making it easy to catch any SDK
1717
### Simple Try-Catch
1818

1919
```python
20-
from devo_global_comms_python.exceptions import DevoException
20+
from devhub_python.exceptions import DevoException
2121

2222
try:
2323
sms_response = client.sms.send_sms(
@@ -81,7 +81,7 @@ except DevoException as e:
8181
### Missing Required Fields
8282

8383
```python
84-
from devo_global_comms_python.models.contacts import CreateContactDto
84+
from devhub_python.models.contacts import CreateContactDto
8585

8686
try:
8787
# Missing required data
@@ -97,7 +97,7 @@ except DevoException as e:
9797

9898
```python
9999
import time
100-
from devo_global_comms_python.exceptions import DevoException
100+
from devhub_python.exceptions import DevoException
101101

102102
def send_with_retry(client, recipient, message, max_retries=3):
103103
for attempt in range(max_retries):
@@ -122,7 +122,7 @@ def send_with_retry(client, recipient, message, max_retries=3):
122122
```python
123123
import time
124124
import random
125-
from devo_global_comms_python.exceptions import DevoException
125+
from devhub_python.exceptions import DevoException
126126

127127
def send_with_backoff(client, recipient, message, max_retries=3):
128128
for attempt in range(max_retries):
@@ -148,7 +148,7 @@ def send_with_backoff(client, recipient, message, max_retries=3):
148148
### Fallback to Alternative Channels
149149

150150
```python
151-
from devo_global_comms_python.exceptions import DevoException
151+
from devhub_python.exceptions import DevoException
152152

153153
def send_message_with_fallback(client, recipient, message):
154154
"""Try SMS first, fallback to WhatsApp if SMS fails."""
@@ -191,7 +191,7 @@ except DevoException as e:
191191

192192
```python
193193
import logging
194-
from devo_global_comms_python.exceptions import DevoException
194+
from devhub_python.exceptions import DevoException
195195

196196
# Configure logging
197197
logging.basicConfig(level=logging.INFO)

docs/examples.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Examples
22

3-
This page contains practical examples to help you get started with the Devo SDK.
3+
This page contains practical examples to help you get started with the DevHub SDK.
44

55
## Complete Working Examples
66

@@ -18,12 +18,12 @@ For detailed, working examples of each feature, check out the `examples/` direct
1818
### Send the Same Message Across All Channels
1919

2020
```python
21-
from devo_global_comms_python import DevoClient
22-
from devo_global_comms_python.exceptions import DevoException
21+
from devhub_python import DevoClient
22+
from devhub_python.exceptions import DevoException
2323

2424
client = DevoClient(api_key="your-api-key")
2525
recipient = "+1234567890"
26-
message = "Hello from Devo SDK!"
26+
message = "Hello from DevHub SDK!"
2727

2828
# Send via SMS
2929
try:
@@ -62,8 +62,8 @@ except DevoException as e:
6262
### Complete Contact Lifecycle
6363

6464
```python
65-
from devo_global_comms_python.models.contacts import CreateContactDto, UpdateContactDto
66-
from devo_global_comms_python.models.contact_groups import CreateContactsGroupDto
65+
from devhub_python.models.contacts import CreateContactDto, UpdateContactDto
66+
from devhub_python.models.contact_groups import CreateContactsGroupDto
6767

6868
# 1. Create a contact
6969
contact_data = CreateContactDto(
@@ -87,7 +87,7 @@ group = client.services.contact_groups.create(group_data)
8787
print(f"Created group: {group.id}")
8888

8989
# 3. Add contact to group
90-
from devo_global_comms_python.models.contacts import AssignToContactsGroupDto
90+
from devhub_python.models.contacts import AssignToContactsGroupDto
9191

9292
assignment = AssignToContactsGroupDto(
9393
contact_ids=[contact.id],
@@ -112,7 +112,7 @@ print(f"Welcome SMS sent: {welcome_sms.id}")
112112

113113
```python
114114
import time
115-
from devo_global_comms_python.exceptions import DevoException
115+
from devhub_python.exceptions import DevoException
116116

117117
def send_message_with_retry(client, recipient, message, max_retries=3):
118118
"""Send a message with retry logic."""
@@ -158,7 +158,7 @@ response = send_message_with_retry(client, "+1234567890", "Important message!")
158158

159159
```python
160160
import os
161-
from devo_global_comms_python import DevoClient
161+
from devhub_python import DevoClient
162162

163163
# Set environment variables
164164
# export DEVO_API_KEY="your-api-key"

docs/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Devo Global Communications Python SDK
1+
# DevHub Python SDK
22

3-
A Python SDK for the Devo Global Communications API, supporting SMS, Email, WhatsApp, RCS, and Contact management.
3+
A Python SDK for the DevHub API, supporting SMS, Email, WhatsApp, RCS, and Contact management.
44

55
## Features
66

@@ -13,13 +13,13 @@ A Python SDK for the Devo Global Communications API, supporting SMS, Email, What
1313
## Installation
1414

1515
```bash
16-
pip install devo-global-comms-python
16+
pip install devhub-python
1717
```
1818

1919
## Quick Example
2020

2121
```python
22-
from devo_global_comms_python import DevoClient
22+
from devhub_python import DevoClient
2323

2424
# Initialize the client
2525
client = DevoClient(api_key="your-api-key")
@@ -39,7 +39,7 @@ Continue to the [Quick Start](quickstart.md) guide to learn how to use the SDK.
3939

4040
## SDK Overview
4141

42-
The Devo SDK is organized into logical resources:
42+
The DevHub SDK is organized into logical resources:
4343

4444
| Resource | Purpose | Example Usage |
4545
|----------|---------|---------------|
@@ -52,5 +52,5 @@ The Devo SDK is organized into logical resources:
5252

5353
## Support
5454

55-
- **Issues**: [GitHub Issues](https://github.com/devotel/devo-global-comms-python/issues)
55+
- **Issues**: [GitHub Issues](https://github.com/devotel/devhub-python/issues)
5656
- **Email**: [support@devotel.io](mailto:support@devotel.io)

docs/quickstart.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
# Quick Start
22

3-
This guide will help you get started with the Devo Global Communications Python SDK.
3+
This guide will help you get started with the DevHub Python SDK.
44

55
## Installation
66

77
Install the SDK using pip:
88

99
```bash
10-
pip install devo-global-comms-python
10+
pip install devhub-python
1111
```
1212

1313
## Authentication
1414

1515
Initialize the client with your API key:
1616

1717
```python
18-
from devo_global_comms_python import DevoClient
18+
from devhub_python import DevoClient
1919

2020
client = DevoClient(api_key="your-api-key")
2121
```
@@ -30,7 +30,7 @@ client = DevoClient(api_key="your-api-key")
3030
```python
3131
sms_response = client.sms.send_sms(
3232
recipient="+1234567890",
33-
message="Hello from Devo SDK!",
33+
message="Hello from DevHub SDK!",
3434
sender="+1987654321"
3535
)
3636
print(f"SMS sent with ID: {sms_response.id}")
@@ -42,7 +42,7 @@ print(f"SMS sent with ID: {sms_response.id}")
4242
email_response = client.email.send_email(
4343
recipient="user@example.com",
4444
subject="Welcome!",
45-
content="Thank you for using Devo SDK.",
45+
content="Thank you for using DevHub SDK.",
4646
sender_email="welcome@example.com"
4747
)
4848
print(f"Email sent with ID: {email_response.id}")
@@ -63,7 +63,7 @@ print(f"WhatsApp message sent with ID: {whatsapp_response.id}")
6363
Always wrap your API calls in try-catch blocks:
6464

6565
```python
66-
from devo_global_comms_python.exceptions import DevoException
66+
from devhub_python.exceptions import DevoException
6767

6868
try:
6969
sms_response = client.sms.send_sms(

docs/sdk/contact_groups.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ The Contact Groups resource allows you to organize contacts into groups for easi
55
## Creating Contact Groups
66

77
```python
8-
from devo_global_comms_python.models.contact_groups import CreateContactsGroupDto
8+
from devhub_python.models.contact_groups import CreateContactsGroupDto
99

1010
# Create a contact group
1111
group_data = CreateContactsGroupDto(
@@ -33,7 +33,7 @@ for group in groups_response.groups:
3333
## Updating Contact Groups
3434

3535
```python
36-
from devo_global_comms_python.models.contact_groups import UpdateContactsGroupDto
36+
from devhub_python.models.contact_groups import UpdateContactsGroupDto
3737

3838
# Update a contact group
3939
update_data = UpdateContactsGroupDto(
@@ -86,7 +86,7 @@ print(f"Found {search_results.total} groups matching 'VIP'")
8686
## Deleting Contact Groups
8787

8888
```python
89-
from devo_global_comms_python.models.contact_groups import DeleteContactsGroupsDto
89+
from devhub_python.models.contact_groups import DeleteContactsGroupsDto
9090

9191
# Delete contact groups
9292
delete_data = DeleteContactsGroupsDto(
@@ -101,7 +101,7 @@ print("Contact group deleted successfully")
101101
## Error Handling
102102

103103
```python
104-
from devo_global_comms_python.exceptions import DevoException
104+
from devhub_python.exceptions import DevoException
105105

106106
try:
107107
group = client.services.contact_groups.create(group_data)

0 commit comments

Comments
 (0)