apialerts


Nameapialerts JSON
Version 1.1.3 PyPI version JSON
download
home_pageNone
SummaryPython wrapper for the API Alerts service
upload_time2025-01-19 14:33:12
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseMIT License Copyright (c) 2024 apialerts Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords api alerts push notifications alert monitoring
VCS
bugtrack_url
requirements aiohttp certifi
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # apialerts-python

Python client for the [apialerts.com](https://apialerts.com/) platform

[Docs](https://apialerts.com/docs/python) • [GitHub](https://github.com/apialerts/apialerts-python) • [PyPI](https://pypi.org/project/apialerts/)

## Installation

Install the latest apialerts package from PyPI

```bash
pip install apialerts
```

### Initialize the client

```python
from apialerts import ApiAlerts

# Configure the client with a default workspace API Key
ApiAlerts.configure('your-api-key')

# Or, Configure the client with a default workspace API Key with logging enabled
ApiAlerts.configure('your-api-key', debug=True)
```

Note: The ApiAlerts class is implemented as a singleton.


### Send Events

```python
from apialerts import ApiAlerts, ApiAlertsEvent

# Construct your alert with additional channel, tags and a link
data = ApiAlertsEvent(
    message='Payment Received',   # required
    channel='revenue',            # optional, uses the default channel if not provided
    tags=['Growth', 'Promotion'], # optional
    link='https://stripe.com'     # optional
)
# Send alert to your workspace using the default API Key
ApiAlerts.send(data)

# Or, Send alert to you project with an alternate API Key
ApiAlerts.send_with_api_key('your-api-key', data)
```

The send_async() and send_with_api_key_async() methods are also available if you need to wait for a successful execution. However, the send() functions are generally always preferred.


### Feedback & Support

If you have any questions or feedback, please create an issue on our GitHub repository. We are always looking to improve our service and would love to hear from you. Thanks for using API Alerts!

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "apialerts",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "API Alerts, push, notifications, alert, monitoring",
    "author": null,
    "author_email": "API Alerts <support@apialerts.com>",
    "download_url": "https://files.pythonhosted.org/packages/85/f6/1cf49dd92d91270e8075bc843a217a69a84f2ebdbe5357a34f581458a4ec/apialerts-1.1.3.tar.gz",
    "platform": null,
    "description": "# apialerts-python\n\nPython client for the [apialerts.com](https://apialerts.com/) platform\n\n[Docs](https://apialerts.com/docs/python) \u2022 [GitHub](https://github.com/apialerts/apialerts-python) \u2022 [PyPI](https://pypi.org/project/apialerts/)\n\n## Installation\n\nInstall the latest apialerts package from PyPI\n\n```bash\npip install apialerts\n```\n\n### Initialize the client\n\n```python\nfrom apialerts import ApiAlerts\n\n# Configure the client with a default workspace API Key\nApiAlerts.configure('your-api-key')\n\n# Or, Configure the client with a default workspace API Key with logging enabled\nApiAlerts.configure('your-api-key', debug=True)\n```\n\nNote: The ApiAlerts class is implemented as a singleton.\n\n\n### Send Events\n\n```python\nfrom apialerts import ApiAlerts, ApiAlertsEvent\n\n# Construct your alert with additional channel, tags and a link\ndata = ApiAlertsEvent(\n    message='Payment Received',   # required\n    channel='revenue',            # optional, uses the default channel if not provided\n    tags=['Growth', 'Promotion'], # optional\n    link='https://stripe.com'     # optional\n)\n# Send alert to your workspace using the default API Key\nApiAlerts.send(data)\n\n# Or, Send alert to you project with an alternate API Key\nApiAlerts.send_with_api_key('your-api-key', data)\n```\n\nThe send_async() and send_with_api_key_async() methods are also available if you need to wait for a successful execution. However, the send() functions are generally always preferred.\n\n\n### Feedback & Support\n\nIf you have any questions or feedback, please create an issue on our GitHub repository. We are always looking to improve our service and would love to hear from you. Thanks for using API Alerts!\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2024 apialerts  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
    "summary": "Python wrapper for the API Alerts service",
    "version": "1.1.3",
    "project_urls": {
        "Documentation": "https://apialerts.com/docs/python",
        "Homepage": "https://apialerts.com",
        "Issues": "https://github.com/apialerts/apialerts-python/issues",
        "Repository": "https://github.com/apialerts/apialerts-python"
    },
    "split_keywords": [
        "api alerts",
        " push",
        " notifications",
        " alert",
        " monitoring"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ca654aad05469bc920c458f615f6412303b1bf0cbf487a9b3289435cc92f56c6",
                "md5": "3d318ae1cc4bcd94c7a80c3a78558d8a",
                "sha256": "1e4de27b3620cf76d2c902d13bbb9ca5fc78c9b686f79f0b66e45a1770478825"
            },
            "downloads": -1,
            "filename": "apialerts-1.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3d318ae1cc4bcd94c7a80c3a78558d8a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 7530,
            "upload_time": "2025-01-19T14:33:10",
            "upload_time_iso_8601": "2025-01-19T14:33:10.142214Z",
            "url": "https://files.pythonhosted.org/packages/ca/65/4aad05469bc920c458f615f6412303b1bf0cbf487a9b3289435cc92f56c6/apialerts-1.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "85f61cf49dd92d91270e8075bc843a217a69a84f2ebdbe5357a34f581458a4ec",
                "md5": "08564780c05224af6a29fc74da97f987",
                "sha256": "80bc6fcdfe64a636a1678d941441925bf2f5f20fbac68bc960b4ce177e619826"
            },
            "downloads": -1,
            "filename": "apialerts-1.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "08564780c05224af6a29fc74da97f987",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 7810,
            "upload_time": "2025-01-19T14:33:12",
            "upload_time_iso_8601": "2025-01-19T14:33:12.266876Z",
            "url": "https://files.pythonhosted.org/packages/85/f6/1cf49dd92d91270e8075bc843a217a69a84f2ebdbe5357a34f581458a4ec/apialerts-1.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-19 14:33:12",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "apialerts",
    "github_project": "apialerts-python",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "aiohttp",
            "specs": [
                [
                    ">=",
                    "3.10.0"
                ],
                [
                    "<",
                    "4.0.0"
                ]
            ]
        },
        {
            "name": "certifi",
            "specs": [
                [
                    ">=",
                    "2024.2.2"
                ]
            ]
        }
    ],
    "lcname": "apialerts"
}
        
Elapsed time: 1.20080s