Skip to main content

An app that provides Django model comment migration

Project description

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

    INSTALLED_APPS =[
        "django_comment_migrate",
        ...
    ]
    
  3. add model

    project/app/model.py

    from django.db import models
    
    class CommentModel(models.Model):
        no_comment = models.TextField()
        aaa = models.IntegerField(default=0, help_text="test default")
        help_text = models.CharField(max_length=40,
                                     help_text="this is help text")
    
        class Meta:
            app_label = 'tests'
            db_table = 'comment_model'
            verbose_name = 'It is Comment Table'
    
  4. 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"
}

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

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-comment-migrate-0.1.5.tar.gz (8.1 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page