Skip to content

provide django version check guidance #245

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 6 commits into from
Feb 3, 2025
Merged

provide django version check guidance #245

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
09522fd
provide django version check guidance
Jibola Jan 31, 2025
e7c892f
consistency
Jibola Jan 31, 2025
d1babe4
resolved comments
Jibola Jan 31, 2025
da5c57f
django-admin --version
Jibola Jan 31, 2025
c12cbfb
format fix
Jibola Feb 3, 2025
66f355d
Merge branch 'main' into readme-dj-ver-guidance
Jibola Feb 3, 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
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,14 @@ $ pip install --pre django-mongodb-backend==5.1.*

From your shell, run the following command to create a new Django project
called `example` using our custom template. Make sure the zipfile referenced
at the end of the template link corresponds to your
version of Django. The snippet below specifies `5.1.x.zip` at the end of
at the end of the template link corresponds to your version of Django.

You can check what version of Django you're using with:
```bash
$ pip show django
Copy link
Collaborator

Choose a reason for hiding this comment

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

The output of $ django-admin --version is a lot simpler. (However, if they follow the instructions above, I'm not sure how they would get to this point without knowing what version of Django they're using.)

Copy link
Collaborator

Choose a reason for hiding this comment

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

Also pip install django-mongodb-backend installs the corresponding Django

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Then let's have main be non-specific?

pip install django-mongodb-backend
and then also check the version.

I've checked with some folks adhoc, they have still just done pip install django-mongodb-backend

Copy link
Collaborator

Choose a reason for hiding this comment

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

I'd rather not omit the version install advice/qualifiers, since there will be plenty of people who want to add this to an existing project on a particular version of Django. What you wrote is fine for now.

```

The snippet below specifies `5.1.x.zip` at the end of
the template url to get the template for any Django version matching 5.1:

```bash
Expand Down
Loading