pioreactor-logs2discord


Namepioreactor-logs2discord JSON
Version 0.3.0 PyPI version JSON
download
home_pagehttps://github.com/Pioreactor/pioreactor-logs2discord
SummaryPush logs generated by Pioreactors to your Discord workspace
upload_time2024-12-28 03:00:14
maintainerNone
docs_urlNone
authorPioreactor
requires_pythonNone
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ### Pioreactor Logs2Discord

This is a Pioreactor plugin to post a bioreactor's logs to a Discord channel.

### Installation

This is a two part installation.

#### 1. Setting up your Discord channel

1. You probably want a dedicated channel for incoming logs, as it can get chatty. So go ahead
and create a dedicated channel in your Discord channel. I've called mine `experiment_logs`.

2. Under your server's dropdown, find "Server Settings" -> "Integrations"

3. Click "Webhooks" -> "New webhook" to create your webhook. Give it a name like `PioreactorLogs`, and choose the channel from step 1. Here's an avatar icon you can use too:

   ![icon](https://github.com/Pioreactor/pioreactorui_frontend/blob/main/public/logo.png)

4. Copy the webhook URL to your clipboard. We'll need this in a moment.

#### 2. Installing this plugin

1. In your Pioreactor interface, click on "Plugins". Find `pioreactor-logs2discord`, and click "Install" beside it. **Or** you can run `pio plugins install pioreactor-logs2discord`. Either way, this plugin will be installed on your leader Pioreactor.

2. After installing (should take less than a minute), click on "Configuration". At the bottom of the page will be a section called `[logs2discord]`.

```
[logs2discord]
discord_webhook_url=
log_level=INFO
```

Add your webhook URL from step 4. here. Click "Save". You can also change the level of logs to report, see [Python logging levels](https://docs.python.org/3/library/logging.html#logging-levels).

3. Power-cycle (reboot) the Pioreactor leader, or ssh into the Pioreactor leader and run `sudo systemctl restart pioreactor_startup_run@logs2discord.service`

4. In your dedicated Discord channel, you should start to see logs arrive!

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Pioreactor/pioreactor-logs2discord",
    "name": "pioreactor-logs2discord",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": null,
    "author": "Pioreactor",
    "author_email": "hello@pioreactor.com",
    "download_url": "https://files.pythonhosted.org/packages/38/be/d9827f97ad0602a7b78492fa2bedf0e928282dca0345dcfbcc65731aaa9c/pioreactor_logs2discord-0.3.0.tar.gz",
    "platform": null,
    "description": "### Pioreactor Logs2Discord\n\nThis is a Pioreactor plugin to post a bioreactor's logs to a Discord channel.\n\n### Installation\n\nThis is a two part installation.\n\n#### 1. Setting up your Discord channel\n\n1. You probably want a dedicated channel for incoming logs, as it can get chatty. So go ahead\nand create a dedicated channel in your Discord channel. I've called mine `experiment_logs`.\n\n2. Under your server's dropdown, find \"Server Settings\" -> \"Integrations\"\n\n3. Click \"Webhooks\" -> \"New webhook\" to create your webhook. Give it a name like `PioreactorLogs`, and choose the channel from step 1. Here's an avatar icon you can use too:\n\n   ![icon](https://github.com/Pioreactor/pioreactorui_frontend/blob/main/public/logo.png)\n\n4. Copy the webhook URL to your clipboard. We'll need this in a moment.\n\n#### 2. Installing this plugin\n\n1. In your Pioreactor interface, click on \"Plugins\". Find `pioreactor-logs2discord`, and click \"Install\" beside it. **Or** you can run `pio plugins install pioreactor-logs2discord`. Either way, this plugin will be installed on your leader Pioreactor.\n\n2. After installing (should take less than a minute), click on \"Configuration\". At the bottom of the page will be a section called `[logs2discord]`.\n\n```\n[logs2discord]\ndiscord_webhook_url=\nlog_level=INFO\n```\n\nAdd your webhook URL from step 4. here. Click \"Save\". You can also change the level of logs to report, see [Python logging levels](https://docs.python.org/3/library/logging.html#logging-levels).\n\n3. Power-cycle (reboot) the Pioreactor leader, or ssh into the Pioreactor leader and run `sudo systemctl restart pioreactor_startup_run@logs2discord.service`\n\n4. In your dedicated Discord channel, you should start to see logs arrive!\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Push logs generated by Pioreactors to your Discord workspace",
    "version": "0.3.0",
    "project_urls": {
        "Homepage": "https://github.com/Pioreactor/pioreactor-logs2discord"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "df4b841cc60ef6f946daf1ef7cb1783447818903eba2d6f6e4dbcd7af2951070",
                "md5": "14aa90f546806d974cf0290548896ecc",
                "sha256": "1de58e4b579009d104ae0a123a22061d572deb65797e2a300700de1932b9c3c1"
            },
            "downloads": -1,
            "filename": "pioreactor_logs2discord-0.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "14aa90f546806d974cf0290548896ecc",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 5560,
            "upload_time": "2024-12-28T03:00:12",
            "upload_time_iso_8601": "2024-12-28T03:00:12.670714Z",
            "url": "https://files.pythonhosted.org/packages/df/4b/841cc60ef6f946daf1ef7cb1783447818903eba2d6f6e4dbcd7af2951070/pioreactor_logs2discord-0.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "38bed9827f97ad0602a7b78492fa2bedf0e928282dca0345dcfbcc65731aaa9c",
                "md5": "9867da6c71cef0a97d63da588ec5c361",
                "sha256": "d51d3a04a53d0dc20edf40689e38f26942ce7be8496f71ec1a26f3da34fc428f"
            },
            "downloads": -1,
            "filename": "pioreactor_logs2discord-0.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "9867da6c71cef0a97d63da588ec5c361",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 4152,
            "upload_time": "2024-12-28T03:00:14",
            "upload_time_iso_8601": "2024-12-28T03:00:14.815164Z",
            "url": "https://files.pythonhosted.org/packages/38/be/d9827f97ad0602a7b78492fa2bedf0e928282dca0345dcfbcc65731aaa9c/pioreactor_logs2discord-0.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-28 03:00:14",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Pioreactor",
    "github_project": "pioreactor-logs2discord",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "pioreactor-logs2discord"
}
        
Elapsed time: 3.95198s