Skip to main content

Open Graph Protocol for Django

Project description

django-ogp-view

ViewクラスにOGP (The Open Graph protocol)を適応させるライブラリです。
本ライブラリのViewMixinを継承させることで、ogp metaタグの実装が簡略化できます。
画面ごとにカスタマイズすることもできます。
SEO (Search Engine Optimization)対策に最適です。

導入

  1. ライブラリをインストールする。
    pip install django-ogp-view
     or
    pip install git+https://github.com/taogya/DjangoOgpView.git
    
  2. settings.pyに以下を追加する。
    INSTALLED_APPS = [
        :
        'django_ogp'
    ]
    OGP_SITE_PROPERTY_MODEL = 'django_ogp.OgpSiteProperty'
    OGP_LOCALE_MASTER_MODEL = 'django_ogp.OgpLocaleMaster'
    OGP_MIMETYPE_MASTER_MODEL = 'django_ogp.OgpMimeTypeMaster'
    
  3. migrateを行う。
    python manage.py makemigrations
    python manage.py migrate
    
  4. OGP用のプロパティを設定する。
    • OgpSiteProperty
      サイト内共通のプロパティ。
    • OgpBasicProperty
      ページごとのプロパティ。
    • OgpCustomProperty
      カスタムプロパティ。
      JSONで指定する。
      JSONについて, keyはpropertyの名称, valueはcontentの値で指定する。
  5. ViewにOgpViewMixinを継承し, 割り当てるプロパティのレコードを割り当てる。
    from django.views import View
    from django_ogp.view import OgpViewMixin
    from django_ogp.models import OgpBasicProperty
    
    class YourView(View, OgpViewMixin):
        ogp = OgpBasicProperty.objects.first()
        :
    
  6. 以下のようにhtmlファイルにdjango_ogp用のタグを追加する。
    {% load django_ogp %}
    <!DOCTYPE html>
    <html lang="en" prefix="{{ view.ogp_global_prefix }}">
    <head prefix="{{ view.ogp_prefix }}">
        {% add_ogp_meta %}
        :
    

Models

django_ogp_er_

補足

  • マイグレーションファイル にはマスターデータ自動生成スクリプトが含まれています。
    不要なデータがありましたら, 管理者画面にて削除するかマイグレーションファイルを修正してください。
  • 以下のモデルはswappableなモデルです。
    • OgpSiteProperty
    • OgpLocaleMaster
    • OgpMimeTypeMaster

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_ogp_view-1.1.0.tar.gz (15.0 kB view hashes)

Uploaded Source

Built Distribution

django_ogp_view-1.1.0-py3-none-any.whl (20.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page