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.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.3.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.3.1
File Size Uploaded
django-db-comments-0.3.1.tar.gz 6.6 kB Details

Built distribution (wheel)

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

Total release size: 12.0 kB

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

Download URL django-db-comments-0.3.1.tar.gz
Size 6.6 kB
Tags Source
SHA-256 checksum
How to use checksums
d97f36349621e34cffc8b8371eb560515319f18407867dfcbfde306accfdfb24
BLAKE2b-256 checksum
How to use checksums
29b5ac0887afb320a2df06980c3253259d3bd170703674fc544b9433f1d2a189
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.5

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

Download URL django_db_comments-0.3.1-py2.py3-none-any.whl
Size 5.4 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
abf5708ca0b719fa422c8795b1c9f8026ac271894e2ef520a4df8715cc17fd10
BLAKE2b-256 checksum
How to use checksums
3b93028a1e147b65fb0cf2a72d387786e27e0105dab4d72b8ec7d2a730bf8bf0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.5

Release history Release notifications | RSS feed

0.4.1

2 release files

0.4.0

2 release files

This release

0.3.1 This release

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