simplebot-mastodon


Namesimplebot-mastodon JSON
Version 0.5.0 PyPI version JSON
download
home_pagehttps://github.com/simplebot-org/simplebot_mastodon
SummaryMastodon/DeltaChat bridge.
upload_time2023-10-06 17:24:41
maintainer
docs_urlNone
authoradbenitez
requires_python
licenseMPL
keywords simplebot plugin deltachat mastodon bridge
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Mastodon Bridge
===============

.. image:: https://img.shields.io/pypi/v/simplebot_mastodon.svg
   :target: https://pypi.org/project/simplebot_mastodon

.. image:: https://img.shields.io/pypi/pyversions/simplebot_mastodon.svg
   :target: https://pypi.org/project/simplebot_mastodon

.. image:: https://pepy.tech/badge/simplebot_mastodon
   :target: https://pepy.tech/project/simplebot_mastodon

.. image:: https://img.shields.io/pypi/l/simplebot_mastodon.svg
   :target: https://pypi.org/project/simplebot_mastodon

.. image:: https://github.com/simplebot-org/simplebot_mastodon/actions/workflows/python-ci.yml/badge.svg
   :target: https://github.com/simplebot-org/simplebot_mastodon/actions/workflows/python-ci.yml

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
   :target: https://github.com/psf/black

A Mastodon <-> DeltaChat bridge plugin for `SimpleBot`_.

If this plugin has collisions with commands from other plugins in your bot, you can set a command prefix like ``/masto_`` for all commands::

  simplebot -a bot@example.com db -s simplebot_mastodon/cmd_prefix masto_

Install
-------

To install run::

  pip install simplebot-mastodon

User Guide
----------

To log in with OAuth, send a message to the bot::

  /login mastodon.social

replace "mastodon.social" with your instance, the bot will reply with an URL that you should open to grant access to your account, copy the code you will receive and send it to the bot.

To log in with your user and password directly(not recommended)::

  /login mastodon.social me@example.com myPassw0rd

Once you log in, A "Home" and "Notifications" chats will appear, in the Home chat you will receive your Home timeline and any message you send there will be published on Mastodon. In the Notifications chat you will receive all the notifications for your account.

If someone sends you a direct message in a private 1:1 conversation, it will be shown as a new chat where you can chat in private with that person, to start a private chat with some Mastodon user, send::

  /dm friend@example.com

and the chat with "friend@example.com" will pop up.

To logout from your account::

  /logout

For more info and all the available commands(follow, block, mute, etc), send this message to the bot::

  /help


.. _SimpleBot: https://github.com/simplebot-org/simplebot

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/simplebot-org/simplebot_mastodon",
    "name": "simplebot-mastodon",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "simplebot plugin deltachat mastodon bridge",
    "author": "adbenitez",
    "author_email": "adbenitez@nauta.cu",
    "download_url": "https://files.pythonhosted.org/packages/dc/ac/cd501d33fc8eb23a08a6fa0818feff61b66f6141b9643c1eaf9d54d4528d/simplebot_mastodon-0.5.0.tar.gz",
    "platform": null,
    "description": "Mastodon Bridge\n===============\n\n.. image:: https://img.shields.io/pypi/v/simplebot_mastodon.svg\n   :target: https://pypi.org/project/simplebot_mastodon\n\n.. image:: https://img.shields.io/pypi/pyversions/simplebot_mastodon.svg\n   :target: https://pypi.org/project/simplebot_mastodon\n\n.. image:: https://pepy.tech/badge/simplebot_mastodon\n   :target: https://pepy.tech/project/simplebot_mastodon\n\n.. image:: https://img.shields.io/pypi/l/simplebot_mastodon.svg\n   :target: https://pypi.org/project/simplebot_mastodon\n\n.. image:: https://github.com/simplebot-org/simplebot_mastodon/actions/workflows/python-ci.yml/badge.svg\n   :target: https://github.com/simplebot-org/simplebot_mastodon/actions/workflows/python-ci.yml\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n   :target: https://github.com/psf/black\n\nA Mastodon <-> DeltaChat bridge plugin for `SimpleBot`_.\n\nIf this plugin has collisions with commands from other plugins in your bot, you can set a command prefix like ``/masto_`` for all commands::\n\n  simplebot -a bot@example.com db -s simplebot_mastodon/cmd_prefix masto_\n\nInstall\n-------\n\nTo install run::\n\n  pip install simplebot-mastodon\n\nUser Guide\n----------\n\nTo log in with OAuth, send a message to the bot::\n\n  /login mastodon.social\n\nreplace \"mastodon.social\" with your instance, the bot will reply with an URL that you should open to grant access to your account, copy the code you will receive and send it to the bot.\n\nTo log in with your user and password directly(not recommended)::\n\n  /login mastodon.social me@example.com myPassw0rd\n\nOnce you log in, A \"Home\" and \"Notifications\" chats will appear, in the Home chat you will receive your Home timeline and any message you send there will be published on Mastodon. In the Notifications chat you will receive all the notifications for your account.\n\nIf someone sends you a direct message in a private 1:1 conversation, it will be shown as a new chat where you can chat in private with that person, to start a private chat with some Mastodon user, send::\n\n  /dm friend@example.com\n\nand the chat with \"friend@example.com\" will pop up.\n\nTo logout from your account::\n\n  /logout\n\nFor more info and all the available commands(follow, block, mute, etc), send this message to the bot::\n\n  /help\n\n\n.. _SimpleBot: https://github.com/simplebot-org/simplebot\n",
    "bugtrack_url": null,
    "license": "MPL",
    "summary": "Mastodon/DeltaChat bridge.",
    "version": "0.5.0",
    "project_urls": {
        "Homepage": "https://github.com/simplebot-org/simplebot_mastodon"
    },
    "split_keywords": [
        "simplebot",
        "plugin",
        "deltachat",
        "mastodon",
        "bridge"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2f81d8f8cff0a75a9d5ea46da0372f4fc9f5f2a60bf6075263a4eb37fc014cfb",
                "md5": "332016c78a691bbc055e8d91924f7da9",
                "sha256": "faa60d7abb114edb145178a45c3f8aedf801821ed81ed2c24d5b5dc470e5aba7"
            },
            "downloads": -1,
            "filename": "simplebot_mastodon-0.5.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "332016c78a691bbc055e8d91924f7da9",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 22688,
            "upload_time": "2023-10-06T17:24:40",
            "upload_time_iso_8601": "2023-10-06T17:24:40.165044Z",
            "url": "https://files.pythonhosted.org/packages/2f/81/d8f8cff0a75a9d5ea46da0372f4fc9f5f2a60bf6075263a4eb37fc014cfb/simplebot_mastodon-0.5.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "dcaccd501d33fc8eb23a08a6fa0818feff61b66f6141b9643c1eaf9d54d4528d",
                "md5": "71408acb9cbc8910c8bb0c2c1ea2fcdc",
                "sha256": "4298972d231937215943f055e4ae58934f3e12f4ccc84d09f0c4a908d4071dab"
            },
            "downloads": -1,
            "filename": "simplebot_mastodon-0.5.0.tar.gz",
            "has_sig": false,
            "md5_digest": "71408acb9cbc8910c8bb0c2c1ea2fcdc",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 26060,
            "upload_time": "2023-10-06T17:24:41",
            "upload_time_iso_8601": "2023-10-06T17:24:41.510738Z",
            "url": "https://files.pythonhosted.org/packages/dc/ac/cd501d33fc8eb23a08a6fa0818feff61b66f6141b9643c1eaf9d54d4528d/simplebot_mastodon-0.5.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-06 17:24:41",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "simplebot-org",
    "github_project": "simplebot_mastodon",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "simplebot-mastodon"
}
        
Elapsed time: 0.13310s