sopel-remind


Namesopel-remind JSON
Version 0.3.0 PyPI version JSON
download
home_page
SummaryReminder plugin for Sopel
upload_time2023-10-13 19:49:44
maintainer
docs_urlNone
author
requires_python<4,>=3.7
licenseEFL-2.0
keywords sopel plugin reminder calendar bot irc
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ============
sopel-remind
============

Sopel plugin ``.in`` command::

    [17:30] Exirel: .in 2h go to the grocery store
    [17:30] Sopel: Exirel: I will remind you that at 2023-10-13 -19:30:00CEST
    (... 2h later ...)
    [19:30] Sopel: Exirel: go to the grocery store

And ``.at`` command::

    [17:30] Exirel: .at 19:30 go to the grocery store
    [17:30] Sopel: Exirel: I will remind you that at 2023-10-13 -19:30:00CEST
    (... 2h later ...)
    [19:30] Sopel: Exirel: go to the grocery store

The ``.in`` command accepts time units ranging from days to seconds::

    .in 1d2h In one day and 2 hours
    .in 2h59m3s In 2 hours, 59 minutes, and 3 seconds

The ``.at`` command is timezone aware, and tries to use the timezone set for
the user. If not found, it will use the timezone set for the channel. If none
is set, it will assume UTC+0.

When using ``.at`` with a past hour, the command will assume tomorrow instead
of today: setting a reminder for 9 a.m. when it's 10 a.m. will create a
reminder for 9 a.m. tomorrow.

You can also use a date instead of a time, or you can use both, placed before
or after the time::

    .at 2023-06-27 Python 3.7 EOL
    .at 12:00 2023-06-27 Python 3.7 EOL
    .at 2023-06-27 12:00 Python 3.7 EOL

Passing only a date will set a reminder on that date with *the current time*
(not adjusted for summer/daylight-savings).

Install
=======

The recommended way to install this plugin is to use ``pip``::

    $ pip install sopel-remind

Note that this plugin requires Python 3.7+ and Sopel 7.1+. It won't work on
Python versions that are not supported by the version of Sopel you are using.

Migration from built-in
=======================

If you used Sopel 7.1 (or any previous version) and its built-in "remind"
plugin, you may want to migrate your reminders to the new plugin. To do that,
you can run the ``sopel-plugins configure remind`` command and allow the script
to perform the migration. This will import the reminders from the original file
before renaming it (by adding the ``.bk`` suffix).

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "sopel-remind",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "<4,>=3.7",
    "maintainer_email": "Florian Strzelecki <florian.strzelecki@gmail.com>",
    "keywords": "sopel,plugin,reminder,calendar,bot,irc",
    "author": "",
    "author_email": "dgw <dgw@technobabbl.es>, Florian Strzelecki <florian.strzelecki@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/91/0d/df3ec8d0def90b190f83557cbde5aba6c985a608ce5aca6e9bbfd5a21746/sopel-remind-0.3.0.tar.gz",
    "platform": "Linux x86, x86-64",
    "description": "============\nsopel-remind\n============\n\nSopel plugin ``.in`` command::\n\n    [17:30] Exirel: .in 2h go to the grocery store\n    [17:30] Sopel: Exirel: I will remind you that at 2023-10-13 -19:30:00CEST\n    (... 2h later ...)\n    [19:30] Sopel: Exirel: go to the grocery store\n\nAnd ``.at`` command::\n\n    [17:30] Exirel: .at 19:30 go to the grocery store\n    [17:30] Sopel: Exirel: I will remind you that at 2023-10-13 -19:30:00CEST\n    (... 2h later ...)\n    [19:30] Sopel: Exirel: go to the grocery store\n\nThe ``.in`` command accepts time units ranging from days to seconds::\n\n    .in 1d2h In one day and 2 hours\n    .in 2h59m3s In 2 hours, 59 minutes, and 3 seconds\n\nThe ``.at`` command is timezone aware, and tries to use the timezone set for\nthe user. If not found, it will use the timezone set for the channel. If none\nis set, it will assume UTC+0.\n\nWhen using ``.at`` with a past hour, the command will assume tomorrow instead\nof today: setting a reminder for 9 a.m. when it's 10 a.m. will create a\nreminder for 9 a.m. tomorrow.\n\nYou can also use a date instead of a time, or you can use both, placed before\nor after the time::\n\n    .at 2023-06-27 Python 3.7 EOL\n    .at 12:00 2023-06-27 Python 3.7 EOL\n    .at 2023-06-27 12:00 Python 3.7 EOL\n\nPassing only a date will set a reminder on that date with *the current time*\n(not adjusted for summer/daylight-savings).\n\nInstall\n=======\n\nThe recommended way to install this plugin is to use ``pip``::\n\n    $ pip install sopel-remind\n\nNote that this plugin requires Python 3.7+ and Sopel 7.1+. It won't work on\nPython versions that are not supported by the version of Sopel you are using.\n\nMigration from built-in\n=======================\n\nIf you used Sopel 7.1 (or any previous version) and its built-in \"remind\"\nplugin, you may want to migrate your reminders to the new plugin. To do that,\nyou can run the ``sopel-plugins configure remind`` command and allow the script\nto perform the migration. This will import the reminders from the original file\nbefore renaming it (by adding the ``.bk`` suffix).\n",
    "bugtrack_url": null,
    "license": "EFL-2.0",
    "summary": "Reminder plugin for Sopel",
    "version": "0.3.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/sopel-irc/sopel-remind/issues",
        "Homepage": "https://github.com/sopel-irc/sopel-remind"
    },
    "split_keywords": [
        "sopel",
        "plugin",
        "reminder",
        "calendar",
        "bot",
        "irc"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "217d20c990389148a1a9e8fb299fbb78dbef7449b0dc7291c3b51aa5cf3bdf31",
                "md5": "92e5fd716485968d203085c5e2875d92",
                "sha256": "cbd317b2a01794f1fc0bd5ee1558024ff9bcdd601f578554c8ee2bf36f6063b1"
            },
            "downloads": -1,
            "filename": "sopel_remind-0.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "92e5fd716485968d203085c5e2875d92",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4,>=3.7",
            "size": 9826,
            "upload_time": "2023-10-13T19:49:42",
            "upload_time_iso_8601": "2023-10-13T19:49:42.715853Z",
            "url": "https://files.pythonhosted.org/packages/21/7d/20c990389148a1a9e8fb299fbb78dbef7449b0dc7291c3b51aa5cf3bdf31/sopel_remind-0.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "910ddf3ec8d0def90b190f83557cbde5aba6c985a608ce5aca6e9bbfd5a21746",
                "md5": "af81dee43befe3957d0b14010813ff00",
                "sha256": "21ae0105da5864ee756baa87fe01d92233f28b8526ac741581a41722810753d1"
            },
            "downloads": -1,
            "filename": "sopel-remind-0.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "af81dee43befe3957d0b14010813ff00",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4,>=3.7",
            "size": 14333,
            "upload_time": "2023-10-13T19:49:44",
            "upload_time_iso_8601": "2023-10-13T19:49:44.258294Z",
            "url": "https://files.pythonhosted.org/packages/91/0d/df3ec8d0def90b190f83557cbde5aba6c985a608ce5aca6e9bbfd5a21746/sopel-remind-0.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-13 19:49:44",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "sopel-irc",
    "github_project": "sopel-remind",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "sopel-remind"
}
        
Elapsed time: 0.12346s