Opened 4 years ago

Closed 8 months ago

#17044 closed New feature (wontfix)

Add "project layout and python path" page to documentation

Reported by: carljm Owned by: nobody
Component: Documentation Version: master
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no


It would be good to have a page in the docs that explains in a bit more detail why the default "startproject" layout is the way it is, how the python path gets set correctly so that it works (e.g. by "script directory" if you use, "current directory" otherwise), what directory should be manually added to sys.path in environments where neither of those apply, where you put packages in the layout if you want them to be top-level and where you put them if they should be inside the project package, etc. Some of this information is in the 1.4 release notes, there's a bunch more discussed in [this mailing list thread].

Change History (2)

comment:1 Changed 9 months ago by iambibhas

Looks like the proposed solution in that google groups thread has been implemented in later versions. The default project structure now is -


comment:2 Changed 8 months ago by claudep

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

Maybe obsolete. Reopen if you have a more concrete proposal.

Note: See TracTickets for help on using tickets.
Back to Top