/django-comment-migrate

这是一个Django model注释迁移的app

Primary LanguagePythonMIT LicenseMIT

Django Comment Migrate

Build https://pypi.org/project/django-comment-migrate/

An app that provides Django model comment migration

English | 简体中文

Feature

  • Automatic migration model help_text to comment [Support customization]
  • Automatically migrate the verbose_name of the model to the table comment [Support customization]
  • Provide a command to migrate the comment of the specified app

Examples

  1. download python package:

    pip install django-comment-migrate
  2. add django_comment_migrate app

    project/project/settings.py

  3. add model

    project/app/model.py

  4. add app

    project/app/settings.py

  5. execute database migrate:

    python manage.py makemigrations
    python manage.py migrate

Now check the database table, comments have been generated.

Custom config

In settings.py:

DCM_COMMENT_KEY='verbose_name'
DCM_TABLE_COMMENT_KEY='verbose_name'
DCM_BACKEND={
        "new-engine": "engine.path"
}
DCM_COMMENT_APP=["app"]

Command

Provides a comment migration command, which allows the database to regenerate comments:

python manage.py migratecomment  [app_label]

The command needs to be executed after all migrations are executed

Running the tests

  1. Install Tox:

    pip install tox
  2. Run:

    tox

Supported Database

  • MySQL
  • PostgreSQL
  • Microsoft SQL Server