Skip to content

DOCSP-43200: Get started with Django #132

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

Closed
wants to merge 34 commits into from
Closed

DOCSP-43200: Get started with Django #132

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
40ffb76
DOCSP-43200: Get started with Django
norareidy Nov 26, 2024
be878e5
edits
norareidy Nov 26, 2024
704c54e
edit code
norareidy Nov 26, 2024
1caf1a3
more info
norareidy Dec 4, 2024
4142196
query steps
norareidy Dec 4, 2024
aa27f12
edit
norareidy Dec 4, 2024
8585730
edits
norareidy Dec 4, 2024
e520bf4
landing page
norareidy Dec 4, 2024
123a2d5
wording
norareidy Dec 4, 2024
d439dac
fix query structure
norareidy Dec 4, 2024
7bb56ea
fixes
norareidy Dec 4, 2024
2d3224f
template edit
norareidy Dec 5, 2024
0fbb2e1
copyable code blocks
norareidy Dec 5, 2024
735bccf
connection string
norareidy Dec 5, 2024
4d9999e
fix image
norareidy Dec 5, 2024
a14aae2
AR feedback
norareidy Dec 13, 2024
b353a24
fix
norareidy Dec 13, 2024
711af57
fix admonition
norareidy Dec 13, 2024
f2b7d40
wording
norareidy Dec 13, 2024
6b599a7
admin site, more crud operations
norareidy Jan 7, 2025
aa3814b
edits
norareidy Jan 7, 2025
a993adf
more wording changes
norareidy Jan 7, 2025
c0c53b1
fix intro text
norareidy Jan 7, 2025
6bd451d
fix
norareidy Jan 7, 2025
6f46a1c
django_mongodb_backend
norareidy Jan 8, 2025
be3b2ed
AC feedback
norareidy Jan 8, 2025
595ee65
next steps edits
norareidy Jan 10, 2025
c863134
TG feedback
norareidy Jan 13, 2025
ecff738
spacing
norareidy Jan 13, 2025
1c06aec
parse_uri edits
norareidy Jan 14, 2025
58b3541
TG feedback 2
norareidy Jan 14, 2025
7bf9018
connection string
norareidy Jan 14, 2025
7a54a24
code fix
norareidy Jan 15, 2025
ea02256
model edit
norareidy Jan 16, 2025
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: 1 addition & 1 deletion source/django-get-started/django-connect-mongodb.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@

DATABASES = {
"default": {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The indentation is incorrect throughout these documents (only 3 spaces).

"ENGINE": "django_mongodb",
"ENGINE": "django_mongodb_backend",
"NAME": "sample_mflix",
"USER": "<username>",
"PASSWORD": "<password>",
Expand All @@ -89,7 +89,7 @@

python3 manage.py runserver
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe this is consistent with the rest of your documentation and you want to leave it alone, but if you are working in a Python 3 virtual environment, you can write python without the 3. Coming from Django's docs, it looks odd to include that 3 on all commands.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was going to raise this too, but would defer to MongoDB-wide conventions. If there are no such conventions, then I prefer python too.


Then, visit http://127.0.0.1:8000/. This page displays a "Congratulations!"

Check failure on line 92 in source/django-get-started/django-connect-mongodb.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules 

[vale] reported by reviewdog 🐶
[MongoDB.Time24h2Digits] Show the hours, minutes, and seconds with two digits each, even if the leading digit is 0 ('1:8').

Raw Output:
{"message": "[MongoDB.Time24h2Digits] Show the hours, minutes, and seconds with two digits each, even if the leading digit is 0 ('1:8').", "location": {"path": "source/django-get-started/django-connect-mongodb.txt", "range": {"start": {"line": 92, "column": 34}}}, "severity": "ERROR"}
message and an image of a rocket.

After completing these steps, you have a Django project configured
Expand Down
4 changes: 2 additions & 2 deletions source/django-get-started/django-create-app.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
.. note:: App Template

The ``django-mongodb-app`` template ensures that your ``app.py`` file
includes the line ``"default_auto_field = 'django_mongodb.fields.ObjectIdAutoField'"``.
includes the line ``"default_auto_field = 'django_mongodb_backend.fields.ObjectIdAutoField'"``.

.. step:: Create models for movie, awards, and viewer data

Expand All @@ -46,7 +46,7 @@
.. code-block:: python

from django.db import models
from django_mongodb.fields import EmbeddedModelField, ArrayField
from django_mongodb_backend.fields import EmbeddedModelField, ArrayField
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: the EmbeddedModelField import and the awards Movie field below will cause errors until this PR is merged


class Movie(models.Model):
title = models.CharField(max_length=200)
Expand Down Expand Up @@ -243,7 +243,7 @@
.. step:: Create migrations for your new models

From your project root, run the following command to create
migrations for the ``Movie``, ``Award``, and ``Viewer`` models and apply

Check failure on line 246 in source/django-get-started/django-create-app.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules 

[vale] reported by reviewdog 🐶
[MongoDB.CommaOxford] Use the Oxford comma in ' migrations for the ``Movie``, ``Award``, and ``Viewer`` models and '.

Raw Output:
{"message": "[MongoDB.CommaOxford] Use the Oxford comma in ' migrations for the ``Movie``, ``Award``, and ``Viewer`` models and '.", "location": {"path": "source/django-get-started/django-create-app.txt", "range": {"start": {"line": 246, "column": 1}}}, "severity": "ERROR"}
the changes to the database:

.. code-block:: bash
Expand Down
2 changes: 1 addition & 1 deletion source/django-get-started/django-install.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@

.. tip::

In the preceding commands, you might need to replace

Check failure on line 53 in source/django-get-started/django-install.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules 

[vale] reported by reviewdog 🐶
[MongoDB.ConciseTerms] 'must' is preferred over 'need to'.

Raw Output:
{"message": "[MongoDB.ConciseTerms] 'must' is preferred over 'need to'.", "location": {"path": "source/django-get-started/django-install.txt", "range": {"start": {"line": 53, "column": 47}}}, "severity": "ERROR"}
``python3`` with the command that points to your Python
3.10+ interpreter.

Expand All @@ -61,7 +61,7 @@

.. code-block:: bash

pip install git+https://github.com/mongodb-labs/django-mongodb
pip install git+https://github.com/mongodb-labs/django-mongodb-backend
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The alpha release is now on PyPI, so maybe this should be pip install django-mongodb-backend. 🤔


This command also installs the following dependencies:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also those dependencies' dependencies but quite possibly not worth mentioning.

  • asgiref
  • dnspython
  • sqlparse
django-mongodb-backend v5.0a1
├── django v5.0.10
│   ├── asgiref v3.8.1
│   └── sqlparse v0.5.3
├── pymongo v4.10.1
│   └── dnspython v2.7.0


Expand Down
Loading