Skip to main content
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.

Release files for django-db-comments 0.4.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for django-db-comments 0.4.1
File Size Uploaded
django-db-comments-0.4.1.tar.gz 6.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for django-db-comments 0.4.1
File Interpreter ABI Platform
django_db_comments-0.4.1-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 12.9 kB

Release files / django-db-comments-0.4.1.tar.gz

Download URL django-db-comments-0.4.1.tar.gz
Size 6.6 kB
Tags Source
SHA-256 checksum
How to use checksums
18a4bdbae8a466d88077fc5022dcc0076293321cd4cce2b385156266cd42463b
BLAKE2b-256 checksum
How to use checksums
dd90f0f01679fcd5761c7877e66018d0d5be382bd1661b33b83386e5d3b6c1db
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.0 CPython/3.10.4

Release files / django_db_comments-0.4.1-py2.py3-none-any.whl

Download URL django_db_comments-0.4.1-py2.py3-none-any.whl
Size 6.3 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
b2b8de7ea89d6a495e9fe99267eb6be2fb1139325c2ab02dff12e872ed49ee86
BLAKE2b-256 checksum
How to use checksums
fe9dae605e031f5a8f7503e8f53e7e736eed00dc95227d76a8972a0160ec9f6d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.0 CPython/3.10.4

Release history Release notifications | RSS feed

This release

0.4.1 This release

2 release files

0.4.0

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.5

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page