Skip to main content

Move your model's verbose name and help_text to database comments

Project description

https://badge.fury.io/py/django-db-comments.svg https://travis-ci.org/vanadium23/django-db-comments.svg?branch=master https://codecov.io/gh/vanadium23/django-db-comments/branch/master/graph/badge.svg

Move your model’s verbose name and help_text to database comments:

Add to INSTALLED_APPS and see description in database.

Documentation

The full documentation is at https://django-db-comments.readthedocs.io.

Quickstart

Install Django Db Comments:

pip install django-db-comments

Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'django_db_comments',
    ...
)

Features

  • Copy verbose_name and help_text to columns in DB, currently: Postgres.

Running Tests

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox

Credits

Tools used in rendering this package:

History

0.4.1 (2022-04-03)

  • Bugfix for models detection and more unit tests. (PR #13)

0.4.0 (2022-04-02)

  • Skip proxy, abstract and not managed model. (Issue #11 by @xjlin0)

0.3.1 (2021-08-02)

  • Update meta information in setup.py.

0.3.0 (2021-08-02)

  • Add comments to tables based on verbose_name of model. (PR #5 by @ssatoh17)

0.2.2 (2019-05-19)

  • Add psqlextra.backend to ALLOWED_ENGINES. (PR #4 by @shuribuzz)

0.2.1 (2019-05-19)

  • Fix case, when help_text or verbose_name use ugettext_lazy from django. (PR #1 by @ErhoSen)

0.2.0 (2019-05-07)

  • First release on PyPI.

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-db-comments-0.4.1.tar.gz (6.6 kB view hashes)

Uploaded source

Built Distribution

django_db_comments-0.4.1-py2.py3-none-any.whl (6.3 kB view hashes)

Uploaded py2 py3

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