Code

Opened 4 years ago

Closed 4 years ago

#12181 closed (invalid)

Django WSGI setup documention makes a critical oversight with unexperienced users

Reported by: tobz Owned by: nobody
Component: Documentation Version: 1.1
Severity: Keywords: setup wsgi settings
Cc: Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

I installed Django with the intent to use it to make a website, but also to learn Python. I have never touched Python before in my life before I went to install Django. When I went to set my settings file in the WSGI configuration file, I supplied 'settings.py' naturally, as after reading the documentation, it gives a value that suggests a full filename. ('filename.extension' rather than just 'filename')

Apparently, in Python, you load modules by just using the 'filename' part, not 'filename.extension' - this seems like a critical oversight when it comes to explaining setup to people unfamiliar with Python.

I can only wonder how many users have this issue when trying to setup Django and as a result give up, and totally miss out on being able to learn both Python and Django.

I urge you to mention this caveat so that users with no Python experience don't get stuck on it like I did.

Attachments (0)

Change History (3)

comment:1 Changed 4 years ago by tobz

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

Forgot to mention, this is the documentation I'm refering to: http://docs.djangoproject.com/en/dev/howto/deployment/modwsgi/

comment:2 Changed 4 years ago by JohnDoe

  • milestone 1.2 deleted

Why aren't you just using the development server to get started ? there's not really any reason to rush deployment if you got nothing running yet.

This is also the suggestion the tutorial has (see. http://docs.djangoproject.com/en/dev/intro/tutorial01/#the-development-server).

comment:3 Changed 4 years ago by russellm

  • Resolution set to invalid
  • Status changed from new to closed

I'm not sure what documentation you are referring to when you say "it gives a value that suggests a full filename".

The documentation you link to gives the speifi example:

os.environ['DJANGO_SETTINGS_MODULE'] = 'mysite.settings'

and I can't find a single reference to settings.py, or the words "full" or "filename".

Tutorial 1 [repeats this advice http://docs.djangoproject.com/en/dev/intro/tutorial01/#playing-with-the-api].

I'm marking this invalid. If you want to provide a specific suggestion of the text that needs to be modified, feel free to reopen with that specific suggestion.

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.