From 90c0fa680b370fe5545bbd295d8c999fa9e861a9 Mon Sep 17 00:00:00 2001 From: "Jeffrey A. Clark" Date: Mon, 7 Apr 2025 10:45:47 -0400 Subject: [PATCH] Add supported libaries table --- docs/source/index.rst | 2 + .../supported-libraries/django-allauth.rst | 28 +++++++------- .../django-debug-toolbar.rst | 29 +++++++------- .../supported-libraries/django-filter.rst | 29 +++++++------- .../django-rest-framework.rst | 28 +++++++------- docs/source/supported-libraries/index.rst | 29 ++++++++++++++ docs/source/supported-libraries/wagtail.rst | 38 ++++++++++--------- docs/source/third-party-library-support.rst | 7 ++-- 8 files changed, 114 insertions(+), 76 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index e070efb..61d2786 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -11,6 +11,8 @@ For testing Django MongoDB Backend with MongoDB's Django fork and third party li MongoDB Backend. .. toctree:: + :maxdepth: 2 + installation third-party-library-support supported-libraries/index diff --git a/docs/source/supported-libraries/django-allauth.rst b/docs/source/supported-libraries/django-allauth.rst index 6e62294..4e3da45 100644 --- a/docs/source/supported-libraries/django-allauth.rst +++ b/docs/source/supported-libraries/django-allauth.rst @@ -1,6 +1,21 @@ Django allauth ============== +.. _django-allauth-results: + +Results +------- + +Via ``dm repo test django-filter`` + ++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ +| **PERCENTAGE PASSED** | **TOTAL** | **PASS** | **FAIL** | **SKIPPED** | **ERROR** | **EXPECTED FAILURES** | **WARNING** | ++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ +| 63% | 1621 | 1023 | 584 | 1 | 13 | 0 | 21 | ++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ + +- `django-filter.txt <../_static/django-filter.txt>`_ + Settings -------- @@ -194,16 +209,3 @@ Via ``dm repo test django-filter -l`` ├── headless_only ├── login_required_mw └── regular - -Results -------- - -Via ``dm repo test django-filter`` - -+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+---------------------------+ -| **TOTAL** | **PASS** | **FAIL** | **SKIPPED** | **ERROR** | **EXPECTED FAILURES** | **WARNING** | **PERCENTAGE PASSED** | -+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+---------------------------+ -| 1621 | 1023 | 584 | 1 | 13 | 0 | 21 | 63% | -+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+---------------------------+ - -- `django-filter.txt <../_static/django-filter.txt>`_ diff --git a/docs/source/supported-libraries/django-debug-toolbar.rst b/docs/source/supported-libraries/django-debug-toolbar.rst index 293626e..404080c 100644 --- a/docs/source/supported-libraries/django-debug-toolbar.rst +++ b/docs/source/supported-libraries/django-debug-toolbar.rst @@ -1,6 +1,21 @@ Django debug toolbar ==================== +.. _django-debug-toolbar-results: + +Results +------- + +Via ``dm repo test django-debug-toolbar`` + ++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ +| **PERCENTAGE PASSED** | **TOTAL** | **PASS** | **FAIL** | **SKIPPED** | **ERROR** | **EXPECTED FAILURES** | **WARNING** | ++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ +| 73% | 262 | 192 | 41 | 26 | 0 | 1 | 0 | ++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ + +- `django-debug-toolbar.txt <../_static/django-debug-toolbar.txt>`_ + Settings -------- @@ -67,17 +82,3 @@ Via ``dm repo test django-filter -l`` ├── urls_invalid.py ├── urls_use_package_urls.py └── views.py - - -Results -------- - -Via ``dm repo test django-debug-toolbar`` - -+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+---------------------------+ -| **TOTAL** | **PASS** | **FAIL** | **SKIPPED** | **ERROR** | **EXPECTED FAILURES** | **WARNING** | **PERCENTAGE PASSED** | -+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+---------------------------+ -| 262 | 192 | 41 | 26 | 0 | 1 | 0 | 73% | -+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+---------------------------+ - -- `django-debug-toolbar.txt <../_static/django-debug-toolbar.txt>`_ diff --git a/docs/source/supported-libraries/django-filter.rst b/docs/source/supported-libraries/django-filter.rst index d8ad0f9..394d4d6 100644 --- a/docs/source/supported-libraries/django-filter.rst +++ b/docs/source/supported-libraries/django-filter.rst @@ -1,6 +1,21 @@ Django filter ============= +Results +------- + +.. _django-filter-results: + +Via ``dm repo test django-filter`` + ++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ +| **PERCENTAGE PASSED** | **TOTAL** | **PASS** | **FAIL** | **SKIPPED** | **ERROR** | **EXPECTED FAILURES** | **WARNING** | ++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ +| 93% | 515 | 480 | 1 | 16 | 15 | 3 | 0 | ++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ + +- `django-filter.txt <../_static/django-filter.txt>`_ + Settings -------- @@ -61,17 +76,3 @@ Via ``dm repo test django-filter -l`` ├── test_widgets.py ├── urls.py └── utils.py - - -Results -------- - -Via ``dm repo test django-filter`` - -+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+---------------------------+ -| **TOTAL** | **PASS** | **FAIL** | **SKIPPED** | **ERROR** | **EXPECTED FAILURES** | **WARNING** | **PERCENTAGE PASSED** | -+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+---------------------------+ -| 515 | 480 | 1 | 16 | 15 | 3 | 0 | 93% | -+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+---------------------------+ - -- `django-filter.txt <../_static/django-filter.txt>`_ diff --git a/docs/source/supported-libraries/django-rest-framework.rst b/docs/source/supported-libraries/django-rest-framework.rst index ed23e53..2575432 100644 --- a/docs/source/supported-libraries/django-rest-framework.rst +++ b/docs/source/supported-libraries/django-rest-framework.rst @@ -1,6 +1,21 @@ Django rest framework ===================== +.. _django-rest-framework-results: + +Results +------- + +Via ``dm repo test django-rest-framework`` + ++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ +| **PERCENTAGE PASSED** | **TOTAL** | **PASS** | **FAIL** | **SKIPPED** | **ERROR** | **EXPECTED FAILURES** | **WARNING** | ++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ +| 81% | 1558 | 1276 | 146 | 136 | 0 | 0 | 4 | ++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ + +- `django-rest-framework.txt <../_static/django-rest-framework.txt>`_ + Settings -------- @@ -105,16 +120,3 @@ Via ``dm repo test django-filter -l`` ├── test_write_only_fields.py ├── urls.py └── utils.py - -Results -------- - -Via ``dm repo test django-rest-framework`` - -+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+---------------------------+ -| **TOTAL** | **PASS** | **FAIL** | **SKIPPED** | **ERROR** | **EXPECTED FAILURES** | **WARNING** | **PERCENTAGE PASSED** | -+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+---------------------------+ -| 1558 | 1276 | 146 | 136 | 0 | 0 | 4 | 81% | -+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+---------------------------+ - -- `django-rest-framework.txt <../_static/django-rest-framework.txt>`_ diff --git a/docs/source/supported-libraries/index.rst b/docs/source/supported-libraries/index.rst index 2c13fe9..9245611 100644 --- a/docs/source/supported-libraries/index.rst +++ b/docs/source/supported-libraries/index.rst @@ -1,9 +1,38 @@ Supported libraries =================== +| + ++------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+ +| **Library** | **Test suites** | **Project examples** | **Known limitations** | **Notes** | ++------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+ +| **django-allauth** | :ref:`63% passing ` | | | | ++------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+ +| **django-debug-toolbar** | :ref:`73% passing ` | | SQL panel not supported. | | +| | | | Use MQL panel from | | +| | | | django-mongodb-extensions. | | ++------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+ +| **django-filter** | :ref:`93% passing ` | | | | ++------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+ +| **django-rest-framework** | :ref:`81% passing ` | | | | ++------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+ +| | | | In addition to custom apps and | Test results prior to | +| | | | migrations, requires custom | merge of `256`_. | +| | | | URL patterns. | | +| **wagtail** | :ref:`43% passing ` | | | | +| | | | | | +| | | | | | +| | | | | | +| | | | | | +| | | | | | ++------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+ + .. toctree:: django-allauth django-debug-toolbar django-filter django-rest-framework wagtail + + +.. _256: https://github.com/mongodb/django-mongodb-backend/pull/256 diff --git a/docs/source/supported-libraries/wagtail.rst b/docs/source/supported-libraries/wagtail.rst index 2d493f4..4a0b76f 100644 --- a/docs/source/supported-libraries/wagtail.rst +++ b/docs/source/supported-libraries/wagtail.rst @@ -1,6 +1,26 @@ Wagtail ======= +.. _wagtail-results: + +Results +------- + +Via ``dm repo test wagtail`` + +.. note:: + + Test results prior to merging https://github.com/mongodb/django-mongodb-backend/pull/256 + ++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ +| **PERCENTAGE PASSED** | **TOTAL** | **PASS** | **FAIL** | **SKIPPED** | **ERROR** | **EXPECTED FAILURES** | **WARNING** | ++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ +| 43% | 4897 | 2124 | 52 | 468 | 2252 | 1 | 0 | ++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+ + +- `wagtail.txt <../_static/wagtail.txt>`_ +- `wagtail2.txt <../_static/wagtail2.txt>`_ + Settings -------- @@ -114,21 +134,3 @@ Via ``dm repo test wagtail -l`` ├── urls_multilang.py ├── urls_multilang_non_root.py └── utils - -Results -------- - -Via ``dm repo test wagtail`` - -.. note:: - - Test results prior to merging https://github.com/mongodb/django-mongodb-backend/pull/256 - -+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+---------------------------+ -| **TOTAL** | **PASS** | **FAIL** | **SKIPPED** | **ERROR** | **EXPECTED FAILURES** | **WARNING** | **PERCENTAGE PASSED** | -+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+---------------------------+ -| 4897 | 2124 | 52 | 468 | 2252 | 1 | 0 | 43% | -+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+---------------------------+ - -- `wagtail.txt <../_static/wagtail.txt>`_ -- `wagtail2.txt <../_static/wagtail2.txt>`_ diff --git a/docs/source/third-party-library-support.rst b/docs/source/third-party-library-support.rst index a5f0d35..85cdfba 100644 --- a/docs/source/third-party-library-support.rst +++ b/docs/source/third-party-library-support.rst @@ -4,7 +4,7 @@ Third party library support Support for third party libraries is determined via the following: - Test suites -- Project integrations +- Project examples - Known limitations Test suites @@ -36,9 +36,8 @@ For each third party library that is supported, the following tasks are performe - Replace static primary key references with dynamic references or static ``ObjectId`` references - -Project integrations --------------------- +Project examples +---------------- Known limitations -----------------