# API Alerts - Python
APIAlerts require the use of API Keys to integrate with your projects.
Copy your API Key from the projects page in the mobile app.
__Get the App__
- Android - [Play Store](https://play.google.com/store/apps/details?id=com.apialerts)
- iOS/Mac - [App Store](https://apps.apple.com/us/app/magpie-api-alerts/id6476410789)
__Links__
- [Integrations](https://apialerts.com/integrations)
## Installation
```bash
pip install apialerts==1.0.3
```
### Sample usage
```python
from apialerts import ApiAlerts, AlertRequest
def alerts_basic():
# Create the ApiAlerts instance
alerts = ApiAlerts()
# Construct your message
data = AlertRequest(
message='Payment Received $10'
)
# Send alert to you project via your API Key
alerts.send(data, 'PROJECT_API_KEY')
```
### Advanced usage
```python
from apialerts import ApiAlerts, AlertRequest
def alerts_advanced():
alerts = ApiAlerts()
# Set a default project API Key and enable logging
alerts.configure('DEFAULT_API_KEY', True)
# Construct your alert with additional tags and a link
data = AlertRequest(
message='Payment Received $10',
tags=['Growth', 'Promotion'],
link='https://apialerts.com'
)
# Send alert to default project specified in configure()
alerts.send(data)
# Or, send alert to an alternate project
alerts.send(data, 'ALTERNATE_API_KEY')
```
Raw data
{
"_id": null,
"home_page": "https://github.com/apialerts/apialerts-python",
"name": "apialerts",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "API Alerts, push, notifications, alert, monitoring",
"author": "API Alerts",
"author_email": "admin@apialerts.com",
"download_url": "https://files.pythonhosted.org/packages/93/6c/4248f804e92f25b04468e5578712cbec887a2e7f34904e0e6aa6cf7a8a5a/apialerts-1.0.3.tar.gz",
"platform": null,
"description": "# API Alerts - Python\n\nAPIAlerts require the use of API Keys to integrate with your projects.\n\nCopy your API Key from the projects page in the mobile app.\n\n__Get the App__\n- Android - [Play Store](https://play.google.com/store/apps/details?id=com.apialerts)\n- iOS/Mac - [App Store](https://apps.apple.com/us/app/magpie-api-alerts/id6476410789)\n\n__Links__\n- [Integrations](https://apialerts.com/integrations)\n\n## Installation\n\n```bash\npip install apialerts==1.0.3\n```\n\n\n### Sample usage\n\n```python\nfrom apialerts import ApiAlerts, AlertRequest\n\ndef alerts_basic():\n # Create the ApiAlerts instance\n alerts = ApiAlerts()\n # Construct your message\n data = AlertRequest(\n message='Payment Received $10'\n )\n # Send alert to you project via your API Key\n alerts.send(data, 'PROJECT_API_KEY')\n```\n\n\n### Advanced usage\n\n```python\nfrom apialerts import ApiAlerts, AlertRequest\n\ndef alerts_advanced():\n alerts = ApiAlerts()\n # Set a default project API Key and enable logging\n alerts.configure('DEFAULT_API_KEY', True)\n # Construct your alert with additional tags and a link\n data = AlertRequest(\n message='Payment Received $10',\n tags=['Growth', 'Promotion'],\n link='https://apialerts.com'\n )\n # Send alert to default project specified in configure()\n alerts.send(data)\n # Or, send alert to an alternate project\n alerts.send(data, 'ALTERNATE_API_KEY')\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python wrapper for the API Alerts service",
"version": "1.0.3",
"project_urls": {
"Homepage": "https://github.com/apialerts/apialerts-python"
},
"split_keywords": [
"api alerts",
" push",
" notifications",
" alert",
" monitoring"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "61592db1a5bbb180c9668ef7f70e01dca27424370f2c81fab3e0dcade1763b4c",
"md5": "0057ed951a21578fb9f0d2038be38860",
"sha256": "33f0c2b7ca5b55a872f0701596a787b1997128737f6b7f06c5b5efdedac29654"
},
"downloads": -1,
"filename": "apialerts-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0057ed951a21578fb9f0d2038be38860",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4296,
"upload_time": "2024-06-24T14:58:26",
"upload_time_iso_8601": "2024-06-24T14:58:26.423725Z",
"url": "https://files.pythonhosted.org/packages/61/59/2db1a5bbb180c9668ef7f70e01dca27424370f2c81fab3e0dcade1763b4c/apialerts-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "936c4248f804e92f25b04468e5578712cbec887a2e7f34904e0e6aa6cf7a8a5a",
"md5": "8aa8b75be7d6739f1e03502945481dd5",
"sha256": "1b098b9c7a18a0e698edef44164311dcd77d5d020d769aa0326794c1eb0d6afe"
},
"downloads": -1,
"filename": "apialerts-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "8aa8b75be7d6739f1e03502945481dd5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4273,
"upload_time": "2024-06-24T14:58:27",
"upload_time_iso_8601": "2024-06-24T14:58:27.986124Z",
"url": "https://files.pythonhosted.org/packages/93/6c/4248f804e92f25b04468e5578712cbec887a2e7f34904e0e6aa6cf7a8a5a/apialerts-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-24 14:58:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "apialerts",
"github_project": "apialerts-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "apialerts"
}
JSON
