Skip to main content

Create models definitions document from your Django project.

Project description

Create models definitions document from your django project. This project help the documentation related to Django models.

travis latest version license requirements status

Quick start

  1. Add “modelsdoc” to your INSTALLED_APPS setting like this
  1. Run python listing_models to listing model definition



You can pass specify app name. Listing only the specified app.

$ python listing_models --app polls


It writes the results to the specified file.

$ python listing_models --output sample.rst


You can choice output format. rst (reStructuredText) or md (Markdown). Default format is rst.

$ python listing_models --format md

Customize Settings


You can specify the apps and change the order.

# output only models of poll


You can specify the field value and change the order.

    ('Fullname', 'verbose_name'),
    ('Name', 'name'),
    ('Type', 'db_type'),
    ('PK', 'primary_key'),
    ('Unique', 'unique'),
    ('Index', 'db_index'),
    ('Null/Blank', 'null_blank'),
    ('Comment', 'comment'),


# TODO more documented


Other settings

# TODO more documented

MODELSDOC_OUTPUT_TEMPLATE = 'modelsdoc/models'
MODELSDOC_OUTPUT_FORMAT = 'rst' # default format
MODELSDOC_MODEL_WRAPPER = 'modelsdoc.wrappers.ModelWrapper'
MODELSDOC_FIELD_WRAPPER = 'modelsdoc.wrappers.FieldWrapper'

Python and Django Support

Django.1.5 Django1.6 Django1.7 Django1.8 Django1.9 Django1.10 Django1.11 Django2.0
Python 2.7  
Python 3.3            
Python 3.4    
Python 3.5      
Python 3.6      


MIT Licence. See the LICENSE file for specific terms.


  • tell-k
  • wanshot


0.1.11(Nov 28, 2019)

  • Add models.yaml template file.

0.1.10(Nov 28, 2019)

  • Add Support YAML format.

0.1.9(Feb 8, 2018)

0.1.8(Dec 3, 2017)

  • Add Support Django2.0

0.1.7(May 29, 2017)

  • Add Support Django1.11 and Python 3.6

0.1.6(Nov 4, 2016)

  • Add Support Django1.10

0.1.5(May 4, 2016)

  • Add Support Python3.5 and Django1.9

0.1.4(Sep 23, 2015)

  • Fixed bug. When print models, linebreak is ignored.
  • Add ManyToManyField’s info on “listing_models” results.

0.1.3(Jul 19, 2015)

  • Fixed bug. install test code.

0.1.2(Jun 21, 2015)

  • Bug fixed. Not include output templates.

0.1.0(Jun 21, 2015)

  • First release

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-modelsdoc-0.1.11.tar.gz (16.9 kB view hashes)

Uploaded source

Built Distribution

django_modelsdoc-0.1.11-py2.py3-none-any.whl (12.2 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