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 coveralls.io downloads latest version license requirements status

Quick start

  1. Add “modelsdoc” to your INSTALLED_APPS setting like this
INSTALLED_APPS = (
    ...
    'modelsdoc',
)
  1. Run python manage.py listing_models to listing model definition

Option

–app(-a)

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

$ python manage.py listing_models --app polls

–output(-o)

It writes the results to the specified file.

$ python manage.py listing_models --output sample.rst

–format(-f)

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

$ python manage.py listing_models --format md

Customize Settings

MODELSDOC_APPS

You can specify the apps and change the order.

# output only models of poll
MODELSDOC_APPS = (polls,)

MODELSDOC_DISPLAY_FIELDS

You can specify the field value and change the order.

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

MODELSDOC_MODEL_OPTIONS

# TODO more documented

MODELSDOC_MODEL_OPTIONS = (
    'unique_together',
    'index_together',
    'ordering',
    'permissions',
    'get_latest_by',
    'order_with_respect_to',
    'db_tablespace',
    'abstract',
    'swappable',
    'select_on_save',
    'default_permissions',
    'default_related_name'
)

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'
MODELSDOC_INCLUDE_AUTO_CREATED = True

Python and Django Support

Django.1.5 Django1.6 Django1.7 Django1.8
Python 2.7
PyPy
Python 3.3    
Python 3.4    

License

MIT Licence. See the LICENSE file for specific terms.

History

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.
  • Add new option “MODELSDOC_INCLUDE_AUTO_CREATED”

0.1.2(Jun 21, 2015)

  • Bug fixed. Not include output templates.

0.1.0(Jun 21, 2015)

  • First release

Project details


Download files

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

Files for django-modelsdoc, version 0.1.4
Filename, size File type Python version Upload date Hashes
Filename, size django_modelsdoc-0.1.4-py2.py3-none-any.whl (13.6 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size django-modelsdoc-0.1.4.tar.gz (15.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page