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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

Details for the file django-db-comments-0.4.1.tar.gz.

File metadata

  • Download URL: django-db-comments-0.4.1.tar.gz
  • Upload date:
  • Size: 6.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for django-db-comments-0.4.1.tar.gz
Algorithm Hash digest
SHA256 18a4bdbae8a466d88077fc5022dcc0076293321cd4cce2b385156266cd42463b
MD5 d630375f26105402868d1c86878ff7e4
BLAKE2b-256 dd90f0f01679fcd5761c7877e66018d0d5be382bd1661b33b83386e5d3b6c1db

See more details on using hashes here.

File details

Details for the file django_db_comments-0.4.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_db_comments-0.4.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b2b8de7ea89d6a495e9fe99267eb6be2fb1139325c2ab02dff12e872ed49ee86
MD5 449ac8692351fd4e22003bdb7d11d360
BLAKE2b-256 fe9dae605e031f5a8f7503e8f53e7e736eed00dc95227d76a8972a0160ec9f6d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page