teams-alerter


Nameteams-alerter JSON
Version 0.2.5 PyPI version JSON
download
home_pageNone
SummaryModule pour envoyer des alertes Teams via Pub/Sub
upload_time2025-08-29 13:17:28
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 🛠️ Teams Alerter

A lightweight Python module to send alerts to Microsoft Teams via Google Cloud Pub/Sub.

---

## 📦 How to Build the Module

Make sure you have the `build` package installed:

```bash
python -m pip install --upgrade build
python -m build
```

This will generate `.whl` and `.tar.gz` files inside the `dist/` folder.

---

## 🔧 Install the Module Locally

From your project directory (with your virtual environment activated):

```bash
pip install ../teams-alerter/dist/teams_alerter-0.1.0-py3-none-any.whl
```

> Adjust the path according to your actual `.whl` file location.

---

## 🚀 How to Use the Module

```python
from teams_alerter import TeamsAlerter

# Example: error handling
try:
    raise RuntimeError("Test error")
except Exception as error:
    TeamsAlerter.handle_error(error, utils)
```

---

## 📤 How to Publish to PyPI

1. Install `twine`:

```bash
pip install twine
```

2. Upload the distribution files:

```bash
twine upload dist/*
```

> A PyPI account is required: https://pypi.org/account/register/

---

## 📁 Recommended Module Structure

```
teams-alerter/
├── teams_alerter/
│   ├── __init__.py
│   ├── core.py
│   └── utils.py
├── pyproject.toml
├── README.md
└── dist/
```

---

## ✅ Requirements

- Python ≥ 3.8
- Google Cloud SDK if you are using Pub/Sub
- Dependencies:
  - `google-cloud-logging`
  - `google-cloud-pubsub`

These dependencies are already listed in your `pyproject.toml`.

---

LIB URL:
https://pypi.org/project/teams-alerter/0.1.0/

How to build and publish ?
pip install build twine
python -m build
twine upload dist/*
dans requirements.txt, ajouter teams-alerter==0.1.0
dans le code: from teams_alerter import TeamsAlerter

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "teams-alerter",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "Toki <t.bakotondrabe-ext@paris-turf.com>",
    "download_url": "https://files.pythonhosted.org/packages/08/ce/e6a1ddd34d807985d128396f2a4110dcc9b28b26257b40bdf591190c335f/teams_alerter-0.2.5.tar.gz",
    "platform": null,
    "description": "# \ud83d\udee0\ufe0f Teams Alerter\r\n\r\nA lightweight Python module to send alerts to Microsoft Teams via Google Cloud Pub/Sub.\r\n\r\n---\r\n\r\n## \ud83d\udce6 How to Build the Module\r\n\r\nMake sure you have the `build` package installed:\r\n\r\n```bash\r\npython -m pip install --upgrade build\r\npython -m build\r\n```\r\n\r\nThis will generate `.whl` and `.tar.gz` files inside the `dist/` folder.\r\n\r\n---\r\n\r\n## \ud83d\udd27 Install the Module Locally\r\n\r\nFrom your project directory (with your virtual environment activated):\r\n\r\n```bash\r\npip install ../teams-alerter/dist/teams_alerter-0.1.0-py3-none-any.whl\r\n```\r\n\r\n> Adjust the path according to your actual `.whl` file location.\r\n\r\n---\r\n\r\n## \ud83d\ude80 How to Use the Module\r\n\r\n```python\r\nfrom teams_alerter import TeamsAlerter\r\n\r\n# Example: error handling\r\ntry:\r\n    raise RuntimeError(\"Test error\")\r\nexcept Exception as error:\r\n    TeamsAlerter.handle_error(error, utils)\r\n```\r\n\r\n---\r\n\r\n## \ud83d\udce4 How to Publish to PyPI\r\n\r\n1. Install `twine`:\r\n\r\n```bash\r\npip install twine\r\n```\r\n\r\n2. Upload the distribution files:\r\n\r\n```bash\r\ntwine upload dist/*\r\n```\r\n\r\n> A PyPI account is required: https://pypi.org/account/register/\r\n\r\n---\r\n\r\n## \ud83d\udcc1 Recommended Module Structure\r\n\r\n```\r\nteams-alerter/\r\n\u251c\u2500\u2500 teams_alerter/\r\n\u2502   \u251c\u2500\u2500 __init__.py\r\n\u2502   \u251c\u2500\u2500 core.py\r\n\u2502   \u2514\u2500\u2500 utils.py\r\n\u251c\u2500\u2500 pyproject.toml\r\n\u251c\u2500\u2500 README.md\r\n\u2514\u2500\u2500 dist/\r\n```\r\n\r\n---\r\n\r\n## \u2705 Requirements\r\n\r\n- Python \u2265 3.8\r\n- Google Cloud SDK if you are using Pub/Sub\r\n- Dependencies:\r\n  - `google-cloud-logging`\r\n  - `google-cloud-pubsub`\r\n\r\nThese dependencies are already listed in your `pyproject.toml`.\r\n\r\n---\r\n\r\nLIB URL:\r\nhttps://pypi.org/project/teams-alerter/0.1.0/\r\n\r\nHow to build and publish ?\r\npip install build twine\r\npython -m build\r\ntwine upload dist/*\r\ndans requirements.txt, ajouter teams-alerter==0.1.0\r\ndans le code: from teams_alerter import TeamsAlerter\r\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Module pour envoyer des alertes Teams via Pub/Sub",
    "version": "0.2.5",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "c59fe4045dcbdc46b097818b4968cff4adfff31c67a7a7142dbf3143e46e3b18",
                "md5": "f69824c0f80773dd4c861be1b554a348",
                "sha256": "ca53f68ea2205f018fd64bf826c67f26863d1ecd08fcbb541bcaf4d99604f88a"
            },
            "downloads": -1,
            "filename": "teams_alerter-0.2.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f69824c0f80773dd4c861be1b554a348",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 6695,
            "upload_time": "2025-08-29T13:17:27",
            "upload_time_iso_8601": "2025-08-29T13:17:27.355111Z",
            "url": "https://files.pythonhosted.org/packages/c5/9f/e4045dcbdc46b097818b4968cff4adfff31c67a7a7142dbf3143e46e3b18/teams_alerter-0.2.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "08cee6a1ddd34d807985d128396f2a4110dcc9b28b26257b40bdf591190c335f",
                "md5": "89b862513e309fc1e6e08d332c1a5ee6",
                "sha256": "443162e3534c98645c5c85e37754ef010032fa04cd6b113628b657dda10a7a32"
            },
            "downloads": -1,
            "filename": "teams_alerter-0.2.5.tar.gz",
            "has_sig": false,
            "md5_digest": "89b862513e309fc1e6e08d332c1a5ee6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 5772,
            "upload_time": "2025-08-29T13:17:28",
            "upload_time_iso_8601": "2025-08-29T13:17:28.842649Z",
            "url": "https://files.pythonhosted.org/packages/08/ce/e6a1ddd34d807985d128396f2a4110dcc9b28b26257b40bdf591190c335f/teams_alerter-0.2.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-29 13:17:28",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "teams-alerter"
}
        
Elapsed time: 1.23426s