wagtailyoast


Namewagtailyoast JSON
Version 0.0.10 PyPI version JSON
download
home_pagehttps://github.com/Aleksi44/wagtailyoast
SummaryYoast For Wagtail
upload_time2023-05-11 17:35:47
maintainer
docs_urlNone
authorAlexis Le Baron
requires_python
licenseGPL-3.0
keywords wagtail yoast seo
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            *****************
Wagtail Yoast SEO
*****************

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

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

`Yoastseo <https://github.com/Yoast/javascript/tree/master/packages/yoastseo>`_ + `Wagtail <https://github.com/wagtail/wagtail>`_ = 🚀

Tested with :

- django==3.0.9
- wagtail==2.10.1
- yoastseo:1.80.0

.. image:: https://d271q0ph7te9f8.cloudfront.net/www/images/screenshot-wagtail-yoast-.original.png

Setup
#####

Install with pip :

``pip install wagtailyoast``

Add wagtailyoast to django apps installed :
::

    INSTALLED_APPS = [
        ...
        'wagtailyoast',
    ]

Add locale used for Yoast and make sure you have STATIC_URL set up in your `settings.py` :
::

    WY_LOCALE = 'en_US'
    STATIC_URL = '/static/'


Add YoastPannel to your Page models :

::

    from wagtail.admin.edit_handlers import TabbedInterface, ObjectList
    from wagtailyoast.edit_handlers import YoastPanel


    class TestPage(Page):
        ...
        keywords = models.CharField(default='', blank=True, max_length=100)

        edit_handler = TabbedInterface([
            ObjectList(Page.content_panels, heading=('Content')),
            ObjectList(Page.promote_panels, heading=('Promotion')),
            ObjectList(Page.settings_panels, heading=('Settings')),
            YoastPanel(
                keywords='keywords',
                title='seo_title',
                search_description='search_description',
                slug='slug'
            ),
        ])


`YoastPanel` params are :

- `keywords` : Default keywords of the page.
- `title` : 'Search Engine Friendly' title. This will appear at the top of the browser window.
- `search_description` : 'Search Engine Friendly' description.
- `slug` : URL of the page.


Development env
###############

::

    git clone git@github.com:Aleksi44/wagtailyoast.git
    pip install -r requirements.txt


Run Django Server
*****************

::

    python manage.py migrate
    python manage.py init
    python manage.py runserver 0.0.0.0:4243


Run Webpack Server
******************

::

    yarn
    yarn start





            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Aleksi44/wagtailyoast",
    "name": "wagtailyoast",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "wagtail yoast seo",
    "author": "Alexis Le Baron",
    "author_email": "alexis@stationspatiale.com",
    "download_url": "https://files.pythonhosted.org/packages/02/d1/22241234aced292794c37278c677871cbc4d2eebdf85cf975718c0220a5f/wagtailyoast-0.0.10.tar.gz",
    "platform": "linux",
    "description": "*****************\nWagtail Yoast SEO\n*****************\n\n.. image:: https://img.shields.io/pypi/v/wagtailyoast\n    :target: https://pypi.org/project/wagtailyoast/\n\n.. image:: https://img.shields.io/pypi/pyversions/wagtailyoast\n    :target: https://pypi.org/project/wagtailyoast/\n\n`Yoastseo <https://github.com/Yoast/javascript/tree/master/packages/yoastseo>`_ + `Wagtail <https://github.com/wagtail/wagtail>`_ = \ud83d\ude80\n\nTested with :\n\n- django==3.0.9\n- wagtail==2.10.1\n- yoastseo:1.80.0\n\n.. image:: https://d271q0ph7te9f8.cloudfront.net/www/images/screenshot-wagtail-yoast-.original.png\n\nSetup\n#####\n\nInstall with pip :\n\n``pip install wagtailyoast``\n\nAdd wagtailyoast to django apps installed :\n::\n\n    INSTALLED_APPS = [\n        ...\n        'wagtailyoast',\n    ]\n\nAdd locale used for Yoast and make sure you have STATIC_URL set up in your `settings.py` :\n::\n\n    WY_LOCALE = 'en_US'\n    STATIC_URL = '/static/'\n\n\nAdd YoastPannel to your Page models :\n\n::\n\n    from wagtail.admin.edit_handlers import TabbedInterface, ObjectList\n    from wagtailyoast.edit_handlers import YoastPanel\n\n\n    class TestPage(Page):\n        ...\n        keywords = models.CharField(default='', blank=True, max_length=100)\n\n        edit_handler = TabbedInterface([\n            ObjectList(Page.content_panels, heading=('Content')),\n            ObjectList(Page.promote_panels, heading=('Promotion')),\n            ObjectList(Page.settings_panels, heading=('Settings')),\n            YoastPanel(\n                keywords='keywords',\n                title='seo_title',\n                search_description='search_description',\n                slug='slug'\n            ),\n        ])\n\n\n`YoastPanel` params are :\n\n- `keywords` : Default keywords of the page.\n- `title` : 'Search Engine Friendly' title. This will appear at the top of the browser window.\n- `search_description` : 'Search Engine Friendly' description.\n- `slug` : URL of the page.\n\n\nDevelopment env\n###############\n\n::\n\n    git clone git@github.com:Aleksi44/wagtailyoast.git\n    pip install -r requirements.txt\n\n\nRun Django Server\n*****************\n\n::\n\n    python manage.py migrate\n    python manage.py init\n    python manage.py runserver 0.0.0.0:4243\n\n\nRun Webpack Server\n******************\n\n::\n\n    yarn\n    yarn start\n\n\n\n\n",
    "bugtrack_url": null,
    "license": "GPL-3.0",
    "summary": "Yoast For Wagtail",
    "version": "0.0.10",
    "project_urls": {
        "Homepage": "https://github.com/Aleksi44/wagtailyoast"
    },
    "split_keywords": [
        "wagtail",
        "yoast",
        "seo"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3ba0859924f129e47f39255a65bba8f817a2a4fefe812ea74dd476f2c2aae147",
                "md5": "73202b5dba53cfe045458b5485bf131b",
                "sha256": "d5443214c184a87b3d8856dcb8df54f97253a95e0741fb57c92a8c30196c8db5"
            },
            "downloads": -1,
            "filename": "wagtailyoast-0.0.10-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "73202b5dba53cfe045458b5485bf131b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 11579525,
            "upload_time": "2023-05-11T17:35:40",
            "upload_time_iso_8601": "2023-05-11T17:35:40.678995Z",
            "url": "https://files.pythonhosted.org/packages/3b/a0/859924f129e47f39255a65bba8f817a2a4fefe812ea74dd476f2c2aae147/wagtailyoast-0.0.10-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "02d122241234aced292794c37278c677871cbc4d2eebdf85cf975718c0220a5f",
                "md5": "eed781e081ac9c06a16c3c19b693a36d",
                "sha256": "ea80ef9acafb43fed6b59536a1db669cda6b7517423e0a4b9eb65dad290e2324"
            },
            "downloads": -1,
            "filename": "wagtailyoast-0.0.10.tar.gz",
            "has_sig": false,
            "md5_digest": "eed781e081ac9c06a16c3c19b693a36d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 11519543,
            "upload_time": "2023-05-11T17:35:47",
            "upload_time_iso_8601": "2023-05-11T17:35:47.927982Z",
            "url": "https://files.pythonhosted.org/packages/02/d1/22241234aced292794c37278c677871cbc4d2eebdf85cf975718c0220a5f/wagtailyoast-0.0.10.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-05-11 17:35:47",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Aleksi44",
    "github_project": "wagtailyoast",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "wagtailyoast"
}
        
Elapsed time: 0.23125s