pelican-embed-microblog


Namepelican-embed-microblog JSON
Version 1.1.0 PyPI version JSON
download
home_page
SummaryA Pelican plugin that wrapps references to twitter et al. Forked from pelican-advance-embed-tweet
upload_time2022-12-11 17:14:07
maintainer
docs_urlNone
authorFundor333, Sven Kreiss
requires_python>=3.9
licenseMIT License Copyright (c) 2017 Fundor333 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 blog pelican social networking static site generator
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Pelican plugin: Embed Microblogs
===================================

Embedding tweets into your Pelican blog posts. This repo is an advance
version of the plugin from
`lqez <https://github.com/lqez/pelican-embed-tweet>`__ which hasn't the
config for the style.

+---------+-----------------------------------------+
| Author   | Chris Rose                             |
+==========+========================================+
+----------+----------------------------------------+
| Homepage | https://offby1.website                 |
+----------+----------------------------------------+
| Github   | https://github.com/offbyone            |
+----------+----------------------------------------+
| Mastodon | https://wandering.shop/@offby1         |
+----------+----------------------------------------+

How to enable it
----------------

1. Install the plugin with ``pip install pelican-embed-microblog``
2. Put ``pelican_embed_microblog`` into plugin list of settings.

   -  ``PLUGINS = ['pelican_embed_microblog']``

3. Add your config into the ``pelicanconf.py``

Config
~~~~~~

The config implement the `Twitter
Api <https://dev.twitter.com/web/embedded-tweets/parameters>`__.

+----------+-----------------------------------------------------------------+
| **Config | **Description**                                                 |
| Label**  |                                                                 |
+==========+=================================================================+
| TWITTER\ | When set to ``hidden``, links in a Tweet are not expanded to    |
| _CARDS   | photo, video, or link previews.                                 |
+----------+-----------------------------------------------------------------+
| TWITTER\ | When set to ``none``, only the cited Tweet will be displayed    |
| _THEME   | even if it is in reply to another Tweet.                        |
+----------+-----------------------------------------------------------------+
| TWITTER\ | When set to ``dark``, displays Tweet with light text over a     |
| _CONVERS | dark background.                                                |
| ATION    |                                                                 |
+----------+-----------------------------------------------------------------+
| TWITTER\ | Adjust the color of Tweet links with a hexadecimal color value. |
| _LINK\_C |                                                                 |
| OLOR     |                                                                 |
+----------+-----------------------------------------------------------------+
| TWITTER\ | The maximum width of the rendered Tweet in whole pixels. This   |
| _WIDTH   | value should be between 250 and 550 pixels.                     |
+----------+-----------------------------------------------------------------+
| TWITTER\ | Float the Tweet ``left``, ``right``, or ``center`` relative to  |
| _ALIGN   | its container. Typically set to allow text or other content to  |
|          | wrap around the Tweet.                                          |
+----------+-----------------------------------------------------------------+
| TWITTER\ | A supported Twitter language code. Loads text components in the |
| _LANG    | specified language. Note: does not affect the text of the cited |
|          | Tweet.                                                          |
+----------+-----------------------------------------------------------------+
| TWITTER\ | When set to true, the Tweet and its embedded page on your site  |
| _DNT     | are not used for purposes that include personalized suggestions |
|          | and personalized ads.                                           |
+----------+-----------------------------------------------------------------+

Usage
-----

When writing a post, you can use any of the following notations to link to microblogging content:

Usernames
~~~~~~~~~

Both Mastodon and Twitter usernames are supported. Any instance of "@username@host.name" will be replaced with a link to the appropriate instances' user account page, and any instance of "@username" will be replaced with a link to the twitter account page for the user.

Twitter statuses
~~~~~~~~~~~~~~~~

To link a Twitter status, you write "@username/status/<numeric-tweet-id>"; essentially, you take the Twitter link itself and you replace "https://twitter.com/" with "@"

Acknowledgments
---------------

Thanks to `lqez <https://github.com/lqez/pelican-embed-tweet>`__ for the
original, and to `fundor333 <https://github.com/fundor333/pelican-advance-embed-tweet>`__ who forked the
original embed tweet plugin, on which this is based.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "pelican-embed-microblog",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "blog,pelican,social networking,static site generator",
    "author": "Fundor333, Sven Kreiss",
    "author_email": "Chris Rose <offline@offby1.net>",
    "download_url": "https://files.pythonhosted.org/packages/ee/19/0d99578da8ed5898b918a55edb334e6fdee6101184d6e98e13c0912b1933/pelican_embed_microblog-1.1.0.tar.gz",
    "platform": null,
    "description": "Pelican plugin: Embed Microblogs\n===================================\n\nEmbedding tweets into your Pelican blog posts. This repo is an advance\nversion of the plugin from\n`lqez <https://github.com/lqez/pelican-embed-tweet>`__ which hasn't the\nconfig for the style.\n\n+---------+-----------------------------------------+\n| Author   | Chris Rose                             |\n+==========+========================================+\n+----------+----------------------------------------+\n| Homepage | https://offby1.website                 |\n+----------+----------------------------------------+\n| Github   | https://github.com/offbyone            |\n+----------+----------------------------------------+\n| Mastodon | https://wandering.shop/@offby1         |\n+----------+----------------------------------------+\n\nHow to enable it\n----------------\n\n1. Install the plugin with ``pip install pelican-embed-microblog``\n2. Put ``pelican_embed_microblog`` into plugin list of settings.\n\n   -  ``PLUGINS = ['pelican_embed_microblog']``\n\n3. Add your config into the ``pelicanconf.py``\n\nConfig\n~~~~~~\n\nThe config implement the `Twitter\nApi <https://dev.twitter.com/web/embedded-tweets/parameters>`__.\n\n+----------+-----------------------------------------------------------------+\n| **Config | **Description**                                                 |\n| Label**  |                                                                 |\n+==========+=================================================================+\n| TWITTER\\ | When set to ``hidden``, links in a Tweet are not expanded to    |\n| _CARDS   | photo, video, or link previews.                                 |\n+----------+-----------------------------------------------------------------+\n| TWITTER\\ | When set to ``none``, only the cited Tweet will be displayed    |\n| _THEME   | even if it is in reply to another Tweet.                        |\n+----------+-----------------------------------------------------------------+\n| TWITTER\\ | When set to ``dark``, displays Tweet with light text over a     |\n| _CONVERS | dark background.                                                |\n| ATION    |                                                                 |\n+----------+-----------------------------------------------------------------+\n| TWITTER\\ | Adjust the color of Tweet links with a hexadecimal color value. |\n| _LINK\\_C |                                                                 |\n| OLOR     |                                                                 |\n+----------+-----------------------------------------------------------------+\n| TWITTER\\ | The maximum width of the rendered Tweet in whole pixels. This   |\n| _WIDTH   | value should be between 250 and 550 pixels.                     |\n+----------+-----------------------------------------------------------------+\n| TWITTER\\ | Float the Tweet ``left``, ``right``, or ``center`` relative to  |\n| _ALIGN   | its container. Typically set to allow text or other content to  |\n|          | wrap around the Tweet.                                          |\n+----------+-----------------------------------------------------------------+\n| TWITTER\\ | A supported Twitter language code. Loads text components in the |\n| _LANG    | specified language. Note: does not affect the text of the cited |\n|          | Tweet.                                                          |\n+----------+-----------------------------------------------------------------+\n| TWITTER\\ | When set to true, the Tweet and its embedded page on your site  |\n| _DNT     | are not used for purposes that include personalized suggestions |\n|          | and personalized ads.                                           |\n+----------+-----------------------------------------------------------------+\n\nUsage\n-----\n\nWhen writing a post, you can use any of the following notations to link to microblogging content:\n\nUsernames\n~~~~~~~~~\n\nBoth Mastodon and Twitter usernames are supported. Any instance of \"@username@host.name\" will be replaced with a link to the appropriate instances' user account page, and any instance of \"@username\" will be replaced with a link to the twitter account page for the user.\n\nTwitter statuses\n~~~~~~~~~~~~~~~~\n\nTo link a Twitter status, you write \"@username/status/<numeric-tweet-id>\"; essentially, you take the Twitter link itself and you replace \"https://twitter.com/\" with \"@\"\n\nAcknowledgments\n---------------\n\nThanks to `lqez <https://github.com/lqez/pelican-embed-tweet>`__ for the\noriginal, and to `fundor333 <https://github.com/fundor333/pelican-advance-embed-tweet>`__ who forked the\noriginal embed tweet plugin, on which this is based.\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2017 Fundor333  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": "A Pelican plugin that wrapps references to twitter et al. Forked from pelican-advance-embed-tweet",
    "version": "1.1.0",
    "split_keywords": [
        "blog",
        "pelican",
        "social networking",
        "static site generator"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "5dac17513095bff421e7f93c57531bc5",
                "sha256": "1562d80c964759af9e5cd29d5ec569a981602565f6ae12780ccce26f418fa18c"
            },
            "downloads": -1,
            "filename": "pelican_embed_microblog-1.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5dac17513095bff421e7f93c57531bc5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 7083,
            "upload_time": "2022-12-11T17:14:05",
            "upload_time_iso_8601": "2022-12-11T17:14:05.734863Z",
            "url": "https://files.pythonhosted.org/packages/83/a5/68a178b9eb61bf136dd22a4517168d310a3a9facae065d6c659fd6cefa94/pelican_embed_microblog-1.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "9412d7d8620d2c94bae250f3e82ccb8e",
                "sha256": "d9f79f288af4b37916c26da2d099d3056e956e0967166cd0922700d1a986e491"
            },
            "downloads": -1,
            "filename": "pelican_embed_microblog-1.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "9412d7d8620d2c94bae250f3e82ccb8e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 14392,
            "upload_time": "2022-12-11T17:14:07",
            "upload_time_iso_8601": "2022-12-11T17:14:07.237572Z",
            "url": "https://files.pythonhosted.org/packages/ee/19/0d99578da8ed5898b918a55edb334e6fdee6101184d6e98e13c0912b1933/pelican_embed_microblog-1.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-11 17:14:07",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "pelican-embed-microblog"
}
        
Elapsed time: 0.01748s