| Name | vonage JSON |
| Version |
4.2.0
JSON |
| download |
| home_page | None |
| Summary | Python Server SDK for using Vonage APIs |
| upload_time | 2025-01-14 17:29:39 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Vonage Python SDK
The Vonage Python SDK Package `vonage` provides a streamlined interface for using Vonage APIs in Python projects. This package includes the `Vonage` class, which simplifies API interactions.
The Vonage class in this package serves as the main entry point for using Vonage APIs. It abstracts away complexities with authentication, HTTP requests and more.
For full API documentation refer to the [Vonage Developer documentation](https://developer.vonage.com).
## Installation
Install the package using pip:
```bash
pip install vonage
```
## Usage
```python
from vonage import Vonage, Auth, HttpClientOptions
# Create an Auth instance
auth = Auth(api_key='your_api_key', api_secret='your_api_secret')
# Create HttpClientOptions instance
# (not required unless you want to change options from the defaults)
options = HttpClientOptions(api_host='api.nexmo.com', timeout=30)
# Create a Vonage instance
vonage = Vonage(auth=auth, http_client_options=options)
```
The Vonage class provides access to various Vonage APIs through its properties. For example, to use methods to call the SMS API:
```python
from vonage_sms import SmsMessage
message = SmsMessage(to='1234567890', from_='Vonage', text='Hello World')
response = client.sms.send(message)
print(response.model_dump_json(exclude_unset=True))
```
You can also access the underlying `HttpClient` instance through the `http_client` property:
```python
user_agent = vonage.http_client.user_agent
```
Raw data
{
"_id": null,
"home_page": null,
"name": "vonage",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Vonage <devrel@vonage.com>",
"download_url": "https://files.pythonhosted.org/packages/64/e7/de958984908389c46cc3f40ba557bb19f0fba0b0f8c8e9859a6c6b030855/vonage-4.2.0.tar.gz",
"platform": null,
"description": "# Vonage Python SDK\n\nThe Vonage Python SDK Package `vonage` provides a streamlined interface for using Vonage APIs in Python projects. This package includes the `Vonage` class, which simplifies API interactions.\n\nThe Vonage class in this package serves as the main entry point for using Vonage APIs. It abstracts away complexities with authentication, HTTP requests and more.\n\nFor full API documentation refer to the [Vonage Developer documentation](https://developer.vonage.com).\n\n## Installation\n\nInstall the package using pip:\n\n```bash\npip install vonage\n```\n\n## Usage\n\n```python\nfrom vonage import Vonage, Auth, HttpClientOptions\n\n# Create an Auth instance\nauth = Auth(api_key='your_api_key', api_secret='your_api_secret')\n\n# Create HttpClientOptions instance\n# (not required unless you want to change options from the defaults)\noptions = HttpClientOptions(api_host='api.nexmo.com', timeout=30)\n\n# Create a Vonage instance\nvonage = Vonage(auth=auth, http_client_options=options)\n```\n\nThe Vonage class provides access to various Vonage APIs through its properties. For example, to use methods to call the SMS API:\n\n```python\nfrom vonage_sms import SmsMessage\n\nmessage = SmsMessage(to='1234567890', from_='Vonage', text='Hello World')\nresponse = client.sms.send(message)\nprint(response.model_dump_json(exclude_unset=True))\n```\n\nYou can also access the underlying `HttpClient` instance through the `http_client` property:\n\n```python\nuser_agent = vonage.http_client.user_agent\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Python Server SDK for using Vonage APIs",
"version": "4.2.0",
"project_urls": {
"homepage": "https://github.com/Vonage/vonage-python-sdk"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a194e5d8108aad81a971c9c0e5aaa4ca926c06b71e16e32055f30f9f4c79974f",
"md5": "bcd72ccbd2b0bcfb9f58d6967a0edf16",
"sha256": "51562e483cd0b590a96edc6056e87ea172a68d54dddfa372e5d4a0226d5021da"
},
"downloads": -1,
"filename": "vonage-4.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bcd72ccbd2b0bcfb9f58d6967a0edf16",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 3441,
"upload_time": "2025-01-14T17:29:38",
"upload_time_iso_8601": "2025-01-14T17:29:38.710205Z",
"url": "https://files.pythonhosted.org/packages/a1/94/e5d8108aad81a971c9c0e5aaa4ca926c06b71e16e32055f30f9f4c79974f/vonage-4.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "64e7de958984908389c46cc3f40ba557bb19f0fba0b0f8c8e9859a6c6b030855",
"md5": "4543381b9a4a2fcc761fe69c9a05af55",
"sha256": "39922b2f5d4afbe6d4363fb6d9d47a5ab69218c3c2682c53f85ce10c68a082e7"
},
"downloads": -1,
"filename": "vonage-4.2.0.tar.gz",
"has_sig": false,
"md5_digest": "4543381b9a4a2fcc761fe69c9a05af55",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 3616,
"upload_time": "2025-01-14T17:29:39",
"upload_time_iso_8601": "2025-01-14T17:29:39.779455Z",
"url": "https://files.pythonhosted.org/packages/64/e7/de958984908389c46cc3f40ba557bb19f0fba0b0f8c8e9859a6c6b030855/vonage-4.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-14 17:29:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Vonage",
"github_project": "vonage-python-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "vonage"
}
