Skip to content

Add supported libaries table #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 7, 2025
Merged

Add supported libaries table #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
28 changes: 15 additions & 13 deletions docs/source/supported-libraries/django-allauth.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
--------

Expand Down Expand Up @@ -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>`_
29 changes: 15 additions & 14 deletions docs/source/supported-libraries/django-debug-toolbar.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
--------

Expand Down Expand Up @@ -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>`_
29 changes: 15 additions & 14 deletions docs/source/supported-libraries/django-filter.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
--------

Expand Down Expand Up @@ -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>`_
28 changes: 15 additions & 13 deletions docs/source/supported-libraries/django-rest-framework.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
--------

Expand Down Expand Up @@ -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>`_
29 changes: 29 additions & 0 deletions docs/source/supported-libraries/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,38 @@
Supported libraries
===================

|

+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
| **Library** | **Test suites** | **Project examples** | **Known limitations** | **Notes** |
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
| **django-allauth** | :ref:`63% passing <django-allauth-results>` | | | |
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
| **django-debug-toolbar** | :ref:`73% passing <django-debug-toolbar-results>` | | SQL panel not supported. | |
| | | | Use MQL panel from | |
| | | | django-mongodb-extensions. | |
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
| **django-filter** | :ref:`93% passing <django-filter-results>` | | | |
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
| **django-rest-framework** | :ref:`81% passing <django-rest-framework-results>` | | | |
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
| | | | In addition to custom apps and | Test results prior to |
| | | | migrations, requires custom | merge of `256`_. |
| | | | URL patterns. | |
| **wagtail** | :ref:`43% passing <wagtail-results>` | | | |
| | | | | |
| | | | | |
| | | | | |
| | | | | |
| | | | | |
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+

.. toctree::
django-allauth
django-debug-toolbar
django-filter
django-rest-framework
wagtail


.. _256: https://github.com/mongodb/django-mongodb-backend/pull/256
38 changes: 20 additions & 18 deletions docs/source/supported-libraries/wagtail.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
--------

Expand Down Expand Up @@ -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>`_
7 changes: 3 additions & 4 deletions docs/source/third-party-library-support.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
-----------------
Expand Down