Skip to content

Commit 49a2d0e

Browse files
aclark4lifeaclark4life
authored
Merge pull request #4 from aclark4life/main
Add supported libaries table
2 parents c769ca9 + 90c0fa6 commit 49a2d0e

File tree

8 files changed

+114
-76
lines changed

8 files changed

+114
-76
lines changed

‎docs/source/index.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ For testing Django MongoDB Backend with MongoDB's Django fork and third party li
1111
MongoDB Backend.
1212

1313
.. toctree::
14+
:maxdepth: 2
15+
1416
installation
1517
third-party-library-support
1618
supported-libraries/index

‎docs/source/supported-libraries/django-allauth.rst‎

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,21 @@
11
Django allauth
22
==============
33

4+
.. _django-allauth-results:
5+
6+
Results
7+
-------
8+
9+
Via ``dm repo test django-filter``
10+
11+
+---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
12+
| **PERCENTAGE PASSED** | **TOTAL** | **PASS** | **FAIL** | **SKIPPED** | **ERROR** | **EXPECTED FAILURES** | **WARNING** |
13+
+---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
14+
| 63% | 1621 | 1023 | 584 | 1 | 13 | 0 | 21 |
15+
+---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
16+
17+
- `django-filter.txt <../_static/django-filter.txt>`_
18+
419
Settings
520
--------
621

@@ -194,16 +209,3 @@ Via ``dm repo test django-filter -l``
194209
├── headless_only
195210
├── login_required_mw
196211
└── regular
197-
198-
Results
199-
-------
200-
201-
Via ``dm repo test django-filter``
202-
203-
+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+---------------------------+
204-
| **TOTAL** | **PASS** | **FAIL** | **SKIPPED** | **ERROR** | **EXPECTED FAILURES** | **WARNING** | **PERCENTAGE PASSED** |
205-
+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+---------------------------+
206-
| 1621 | 1023 | 584 | 1 | 13 | 0 | 21 | 63% |
207-
+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+---------------------------+
208-
209-
- `django-filter.txt <../_static/django-filter.txt>`_

‎docs/source/supported-libraries/django-debug-toolbar.rst‎

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,21 @@
11
Django debug toolbar
22
====================
33

4+
.. _django-debug-toolbar-results:
5+
6+
Results
7+
-------
8+
9+
Via ``dm repo test django-debug-toolbar``
10+
11+
+---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
12+
| **PERCENTAGE PASSED** | **TOTAL** | **PASS** | **FAIL** | **SKIPPED** | **ERROR** | **EXPECTED FAILURES** | **WARNING** |
13+
+---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
14+
| 73% | 262 | 192 | 41 | 26 | 0 | 1 | 0 |
15+
+---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
16+
17+
- `django-debug-toolbar.txt <../_static/django-debug-toolbar.txt>`_
18+
419
Settings
520
--------
621

@@ -67,17 +82,3 @@ Via ``dm repo test django-filter -l``
6782
├── urls_invalid.py
6883
├── urls_use_package_urls.py
6984
└── views.py
70-
71-
72-
Results
73-
-------
74-
75-
Via ``dm repo test django-debug-toolbar``
76-
77-
+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+---------------------------+
78-
| **TOTAL** | **PASS** | **FAIL** | **SKIPPED** | **ERROR** | **EXPECTED FAILURES** | **WARNING** | **PERCENTAGE PASSED** |
79-
+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+---------------------------+
80-
| 262 | 192 | 41 | 26 | 0 | 1 | 0 | 73% |
81-
+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+---------------------------+
82-
83-
- `django-debug-toolbar.txt <../_static/django-debug-toolbar.txt>`_

‎docs/source/supported-libraries/django-filter.rst‎

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,21 @@
11
Django filter
22
=============
33

4+
Results
5+
-------
6+
7+
.. _django-filter-results:
8+
9+
Via ``dm repo test django-filter``
10+
11+
+---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
12+
| **PERCENTAGE PASSED** | **TOTAL** | **PASS** | **FAIL** | **SKIPPED** | **ERROR** | **EXPECTED FAILURES** | **WARNING** |
13+
+---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
14+
| 93% | 515 | 480 | 1 | 16 | 15 | 3 | 0 |
15+
+---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
16+
17+
- `django-filter.txt <../_static/django-filter.txt>`_
18+
419
Settings
520
--------
621

@@ -61,17 +76,3 @@ Via ``dm repo test django-filter -l``
6176
├── test_widgets.py
6277
├── urls.py
6378
└── utils.py
64-
65-
66-
Results
67-
-------
68-
69-
Via ``dm repo test django-filter``
70-
71-
+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+---------------------------+
72-
| **TOTAL** | **PASS** | **FAIL** | **SKIPPED** | **ERROR** | **EXPECTED FAILURES** | **WARNING** | **PERCENTAGE PASSED** |
73-
+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+---------------------------+
74-
| 515 | 480 | 1 | 16 | 15 | 3 | 0 | 93% |
75-
+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+---------------------------+
76-
77-
- `django-filter.txt <../_static/django-filter.txt>`_

‎docs/source/supported-libraries/django-rest-framework.rst‎

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,21 @@
11
Django rest framework
22
=====================
33

4+
.. _django-rest-framework-results:
5+
6+
Results
7+
-------
8+
9+
Via ``dm repo test django-rest-framework``
10+
11+
+---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
12+
| **PERCENTAGE PASSED** | **TOTAL** | **PASS** | **FAIL** | **SKIPPED** | **ERROR** | **EXPECTED FAILURES** | **WARNING** |
13+
+---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
14+
| 81% | 1558 | 1276 | 146 | 136 | 0 | 0 | 4 |
15+
+---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
16+
17+
- `django-rest-framework.txt <../_static/django-rest-framework.txt>`_
18+
419
Settings
520
--------
621

@@ -105,16 +120,3 @@ Via ``dm repo test django-filter -l``
105120
├── test_write_only_fields.py
106121
├── urls.py
107122
└── utils.py
108-
109-
Results
110-
-------
111-
112-
Via ``dm repo test django-rest-framework``
113-
114-
+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+---------------------------+
115-
| **TOTAL** | **PASS** | **FAIL** | **SKIPPED** | **ERROR** | **EXPECTED FAILURES** | **WARNING** | **PERCENTAGE PASSED** |
116-
+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+---------------------------+
117-
| 1558 | 1276 | 146 | 136 | 0 | 0 | 4 | 81% |
118-
+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+---------------------------+
119-
120-
- `django-rest-framework.txt <../_static/django-rest-framework.txt>`_

‎docs/source/supported-libraries/index.rst‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,38 @@
11
Supported libraries
22
===================
33

4+
|
5+
6+
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
7+
| **Library** | **Test suites** | **Project examples** | **Known limitations** | **Notes** |
8+
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
9+
| **django-allauth** | :ref:`63% passing <django-allauth-results>` | | | |
10+
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
11+
| **django-debug-toolbar** | :ref:`73% passing <django-debug-toolbar-results>` | | SQL panel not supported. | |
12+
| | | | Use MQL panel from | |
13+
| | | | django-mongodb-extensions. | |
14+
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
15+
| **django-filter** | :ref:`93% passing <django-filter-results>` | | | |
16+
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
17+
| **django-rest-framework** | :ref:`81% passing <django-rest-framework-results>` | | | |
18+
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
19+
| | | | In addition to custom apps and | Test results prior to |
20+
| | | | migrations, requires custom | merge of `256`_. |
21+
| | | | URL patterns. | |
22+
| **wagtail** | :ref:`43% passing <wagtail-results>` | | | |
23+
| | | | | |
24+
| | | | | |
25+
| | | | | |
26+
| | | | | |
27+
| | | | | |
28+
+------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
29+
430
.. toctree::
531
django-allauth
632
django-debug-toolbar
733
django-filter
834
django-rest-framework
935
wagtail
36+
37+
38+
.. _256: https://github.com/mongodb/django-mongodb-backend/pull/256

‎docs/source/supported-libraries/wagtail.rst‎

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
11
Wagtail
22
=======
33

4+
.. _wagtail-results:
5+
6+
Results
7+
-------
8+
9+
Via ``dm repo test wagtail``
10+
11+
.. note::
12+
13+
Test results prior to merging https://github.com/mongodb/django-mongodb-backend/pull/256
14+
15+
+---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
16+
| **PERCENTAGE PASSED** | **TOTAL** | **PASS** | **FAIL** | **SKIPPED** | **ERROR** | **EXPECTED FAILURES** | **WARNING** |
17+
+---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
18+
| 43% | 4897 | 2124 | 52 | 468 | 2252 | 1 | 0 |
19+
+---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
20+
21+
- `wagtail.txt <../_static/wagtail.txt>`_
22+
- `wagtail2.txt <../_static/wagtail2.txt>`_
23+
424
Settings
525
--------
626

@@ -114,21 +134,3 @@ Via ``dm repo test wagtail -l``
114134
├── urls_multilang.py
115135
├── urls_multilang_non_root.py
116136
└── utils
117-
118-
Results
119-
-------
120-
121-
Via ``dm repo test wagtail``
122-
123-
.. note::
124-
125-
Test results prior to merging https://github.com/mongodb/django-mongodb-backend/pull/256
126-
127-
+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+---------------------------+
128-
| **TOTAL** | **PASS** | **FAIL** | **SKIPPED** | **ERROR** | **EXPECTED FAILURES** | **WARNING** | **PERCENTAGE PASSED** |
129-
+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+---------------------------+
130-
| 4897 | 2124 | 52 | 468 | 2252 | 1 | 0 | 43% |
131-
+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+---------------------------+
132-
133-
- `wagtail.txt <../_static/wagtail.txt>`_
134-
- `wagtail2.txt <../_static/wagtail2.txt>`_

‎docs/source/third-party-library-support.rst‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Third party library support
44
Support for third party libraries is determined via the following:
55

66
- Test suites
7-
- Project integrations
7+
- Project examples
88
- Known limitations
99

1010
Test suites
@@ -36,9 +36,8 @@ For each third party library that is supported, the following tasks are performe
3636

3737
- Replace static primary key references with dynamic references or static ``ObjectId`` references
3838

39-
40-
Project integrations
41-
--------------------
39+
Project examples
40+
----------------
4241

4342
Known limitations
4443
-----------------

0 commit comments

Comments
 (0)