You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Use the version of `django-mongodb-backend` that corresponds to your version of
15
14
Django. For example, to get the latest compatible release for Django 5.2.x:
15
+
16
16
```bash
17
17
pip install django-mongodb-backend==5.2.*
18
18
```
19
19
20
20
## Quickstart
21
21
22
-
### Start project
22
+
### Create a project
23
23
24
24
From your shell, run the following command to create a new Django project
25
-
called `example` using our custom template. Make sure the zipfile referenced
26
-
at the end of the template link corresponds to your version of Django.
25
+
called `example` using our project template. Make sure the zipfile referenced
26
+
at the end of the template URL corresponds to your version of Django (e.g.
27
+
`5.2.x.zip` for any Django 5.2.x version).
27
28
28
-
You can check what version of Django you're using with:
29
29
```bash
30
-
django-admin --version
30
+
django-admin startproject example --template https://github.com/mongodb-labs/django-mongodb-project/archive/refs/heads/5.2.x.zip
31
31
```
32
32
33
-
The snippet below specifies `5.2.x.zip` at the end of
34
-
the template url to get the template for any Django version matching 5.2:
33
+
You can check what version of Django you're using with:
35
34
36
35
```bash
37
-
django-admin startproject example --template https://github.com/mongodb-labs/django-mongodb-project/archive/refs/heads/5.2.x.zip
36
+
django-admin --version
38
37
```
39
38
40
-
41
39
### Connect to the database
42
40
43
41
Navigate to your `example/settings.py` file and replace the `DATABASES`
@@ -54,49 +52,34 @@ DATABASES = {
54
52
```
55
53
56
54
### Run the server
57
-
To verify that you installed Django MongoDB Backend and correctly configured your project, run the following command from your project root:
55
+
56
+
To verify that you installed Django MongoDB Backend and correctly configured
57
+
your project, run the following command from your project root:
58
+
58
59
```bash
59
60
python manage.py runserver
60
61
```
61
-
Then, visit http://127.0.0.1:8000/. This page displays a "Congratulations!" message and an image of a rocket.
62
-
63
-
64
-
## Capabilities of Django MongoDB Backend
65
62
66
-
-**Model MongoDB Documents Through Django’s ORM**
63
+
Then, visit http://127.0.0.1:8000/. This page displays a "Congratulations!"
64
+
message and an image of a rocket.
67
65
68
-
- Store Django model instances as MongoDB documents.
69
-
- Maps Django's built-in fields to MongoDB data types.
70
-
- Provides custom fields for arrays (`ArrayField`) and embedded documents (`EmbeddedModelField`).
71
-
- Supports core migration functionalities.
72
-
-**Index Management**
73
-
- Create single, compound, partial, and unique indexes using Django Indexes.
74
-
-**Querying Data**
75
-
- Supports most of the Django QuerySet API.
76
-
- Supports relational field usage and executes `JOIN` operations with MQL.
77
-
- A custom `QuerySet.raw_aggregate` method exposes MongoDB-specific operations like Vector Search, Atlas Search, and GeoSpatial querying to yield Django QuerySet results.
78
-
-**Administrator Dashboard & Authentication**
79
-
- Manage your data in Django’s admin site.
80
-
- Fully integrated with Django's authentication framework.
81
-
- Supports native user management features like creating users and session management.
66
+
## Getting Help
82
67
83
-
84
-
### Issues & Help
85
-
86
-
We're glad to have such a vibrant community of users of Django MongoDB Backend.
87
-
You can ask questions and request features through the
68
+
You can ask usage questions on the
88
69
[MongoDB Community Forums](https://www.mongodb.com/community/forums/tag/python).
89
70
71
+
## Reporting Bugs and Feature Requests
90
72
91
-
#### Bugs / Feature Requests
92
-
To report a bug or to request a new feature in Django MongoDB Backend, please open an issue in JIRA, our issue-management tool, using the following steps:
73
+
To report a bug or request a new feature in Django MongoDB Backend, please open
74
+
an issue in JIRA:
93
75
94
76
1.[Create a JIRA account.](https://jira.mongodb.org/)
95
-
96
77
2. Navigate to the [Python Integrations project](https://jira.mongodb.org/projects/INTPYTHON/).
78
+
3. Click **Create Issue**. Please provide as much information as possible about
79
+
the issue and the steps to reproduce it.
97
80
98
-
3. Click **Create Issue**. Please provide as much information as possible about the issue and the steps to reproduce it.
99
-
100
-
Bug reports in JIRA for the Django MongoDB Backend project can be viewed by everyone.
81
+
Bug reports for the Django MongoDB Backend project can be viewed by everyone.
101
82
102
-
If you identify a security vulnerability in the driver or in any other MongoDB project, please report it according to the instructions found in [Create a Vulnerability Report](https://www.mongodb.com/docs/manual/tutorial/create-a-vulnerability-report/).
83
+
If you identify a security vulnerability in this project or in any other
84
+
MongoDB project, please report it according to the instructions found at
85
+
[Create a Vulnerability Report](https://www.mongodb.com/docs/manual/tutorial/create-a-vulnerability-report/).
0 commit comments