Skip to main content
https://secure.travis-ci.org/zbyte64/django-dockit.png?branch=master

Introduction

Django-DocKit provides a Document ORM in django. DocKit attempts to provide a batteries included experience while preserving django’s various conventions.

Features

  • Backendable support for document and index storage

    • Mongodb

    • Django Model with support for celery or ztask indexing

  • Integrates with hyperadmin (https://github.com/zbyte64/django-hyperadmin)

    • Supports inlines

    • List Field support

    • Supports editing documents with deeply nested schemas

  • Class based views

  • Django forms support

  • Dynamically typed documents and schemas

  • Document and Index routing to multiple backends

Help & Feedback

We have a mailing list for general discussion and help: http://groups.google.com/group/django-dockit/

Installation

Requirements

  • Python 2.6 or later

  • Django 1.3 or later

Settings

Put ‘dockit’ into your INSTALLED_APPS section of your settings file.

Configuring Document Store Backend

Django Document

Set the following in your settings file:

DOCKIT_BACKENDS = {
    'default': {
        'ENGINE': 'dockit.backends.djangodocument.backend.ModelDocumentStorage',
    }
}
DOCKIT_INDEX_BACKENDS = {
    'default': {
        'ENGINE': 'dockit.backends.djangodocument.backend.ModelIndexStorage',
    },
}

#Uncomment to use django-ztask for indexing
#DOCKIT_INDEX_BACKENDS['default']['INDEX_TASKS'] = 'dockit.backends.djangodocument.tasks.ZTaskIndexTasks'

#Uncomment to use django-celery for indexing
#DOCKIT_INDEX_BACKENDS['default']['INDEX_TASKS'] = 'dockit.backends.djangodocument.tasks.CeleryIndexTasks'

Then add ‘dockit.backends.djangodocument’ to INSTALLED_APPS

Mongodb

Set the following in your settings file:

DOCKIT_BACKENDS = {
    'default': {
        'ENGINE':'dockit.backends.mongo.backend.MongoDocumentStorage',
        'USER':'travis',
        'PASSWORD':'test',
        'DB':'mydb_test',
        'HOST':'127.0.0.1',
        'PORT':27017,
    }
}
DOCKIT_INDEX_BACKENDS = {
    'default': {
        'ENGINE':'dockit.backends.mongo.backend.MongoIndexStorage',
        'USER':'travis',
        'PASSWORD':'test',
        'DB':'mydb_test',
        'HOST':'127.0.0.1',
        'PORT':27017,
    },
}

Metadata

Release files for django-dockit 0.0.13

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-dockit 0.0.13
File Size Uploaded Provenance
django-dockit-0.0.13.tar.gz 82.4 kB Without provenance Details

Release files / django-dockit-0.0.13.tar.gz

Download URL django-dockit-0.0.13.tar.gz
Size 82.4 kB
Tags Source
SHA-256 checksum
How to use checksums
9af02f8db38e96b66d6f7016f4492456556fe68c03ab628771387dfc18d16aff
BLAKE2b-256 checksum
How to use checksums
4c2d277a3ce43d6782af94caf94e70955fcdcb8d387821d2c3625df3a1b6d0a8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for django-dockit 0.0.13

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

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