==================
Django MongoDB CLI
==================

About
=====

This library is for developers of third party Django libraries who want to add
compatibility with :ref:`Django MongoDB Backend <django-mongodb-backend>`.

The ``dm`` command line tool provides utilities for running tests for:

- :ref:`Third party libraries <third-party-libraries>`
- :ref:`Django MongoDB Backend <django-mongodb-backend>`
- :ref:`MongoDB's Django fork <mongodb-django-fork>`

.. admonition:: End users of Django MongoDB Backend

    Please read the documentation for :ref:`Django MongoDB Backend
    <django-mongodb-backend>`.

Table of Contents
=================

.. toctree::
   third-party-library-support/index
   installation
   usage/index
   supported-libraries/index
   glossary

.. _`Django MongoDB Backend documentation`: https://www.mongodb.com/docs/languages/python/django-mongodb/v5.1/
.. _`Django projects`: https://docs.djangoproject.com/en/5.2/intro/tutorial01/#creating-a-project