Welcome to django_db_comments’s documentation!¶

Contents:

Django Db Comments¶

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:

Installation¶

At the command line:

$ easy_install django-db-comments

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv django-db-comments
$ pip install django-db-comments

Usage¶

To use django_db_comments in a project, add it to your INSTALLED_APPS:

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

Contributing¶

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions¶

Report Bugs¶

Report bugs at https://github.com/vanadium23/django-db-comments/issues.

If you are reporting a bug, please include:

Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.

Fix Bugs¶

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features¶

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation¶

Django Db Comments could always use more documentation, whether as part of the official Django Db Comments docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback¶

The best way to send feedback is to file an issue at https://github.com/vanadium23/django-db-comments/issues.

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!¶

Ready to contribute? Here’s how to set up django-db-comments for local development.

Fork the django-db-comments repo on GitHub.

Clone your fork locally:

$ git clone git@github.com:your_name_here/django-db-comments.git

Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
```
$ mkvirtualenv django-db-comments
$ cd django-db-comments/
$ python setup.py develop
```
Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
```
$ flake8 django_db_comments tests
$ python setup.py test
$ tox
```
To get flake8 and tox, just pip install them into your virtualenv.

Commit your changes and push your branch to GitHub:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check https://travis-ci.org/vanadium23/django-db-comments/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ python -m unittest tests.test_django_db_comments

Credits¶

Development Lead¶

Ivan Chernov <chernoffivan@gmail.com>

Contributors¶

@ErhoSen https://github.com/ErhoSen
@shuribuzz https://github.com/shuribuzz

None yet. Why not be the first?

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.