Debian Codegraph @

docs/faq/general.txt

raw
1 ============
2 FAQ: General
3 ============
4
5 Why does this project exist?
6 ============================
7
8 Django grew from a very practical need: World Online, a newspaper web
9 operation, is responsible for building intensive web applications on journalism
10 deadlines. In the fast-paced newsroom, World Online often has only a matter of
11 hours to take a complicated web application from concept to public launch.
12
13 At the same time, the World Online web developers have consistently been
14 perfectionists when it comes to following best practices of web development.
15
16 In fall 2003, the World Online developers (Adrian Holovaty and Simon Willison)
17 ditched PHP and began using Python to develop its websites. As they built
18 intensive, richly interactive sites such as Lawrence.com, they began to extract
19 a generic web development framework that let them build web applications more
20 and more quickly. They tweaked this framework constantly, adding improvements
21 over two years.
22
23 In summer 2005, World Online decided to open-source the resulting software,
24 Django. Django would not be possible without a whole host of open-source
25 projects -- `Apache`_, `Python`_, and `PostgreSQL`_ to name a few -- and we're
26 thrilled to be able to give something back to the open-source community.
27
28 .. _Apache: https://httpd.apache.org/
29 .. _Python: https://www.python.org/
30 .. _PostgreSQL: https://www.postgresql.org/
31
32 What does "Django" mean, and how do you pronounce it?
33 =====================================================
34
35 Django is named after `Django Reinhardt`_, a jazz manouche guitarist from the 1930s
36 to early 1950s. To this day, he's considered one of the best guitarists of all time.
37
38 Listen to his music. You'll like it.
39
40 Django is pronounced **JANG**-oh. Rhymes with FANG-oh. The "D" is silent.
41
42 We've also recorded an `audio clip of the pronunciation`_.
43
44 .. _Django Reinhardt: https://en.wikipedia.org/wiki/Django_Reinhardt
45 .. _audio clip of the pronunciation: https://www.red-bean.com/~adrian/django_pronunciation.mp3
46
47 Is Django stable?
48 =================
49
50 Yes, it's quite stable. Companies like Disqus, Instagram, Pinterest, and
51 Mozilla have been using Django for many years. Sites built on Django have
52 weathered traffic spikes of over 50 thousand hits per second.
53
54 Does Django scale?
55 ==================
56
57 Yes. Compared to development time, hardware is cheap, and so Django is
58 designed to take advantage of as much hardware as you can throw at it.
59
60 Django uses a "shared-nothing" architecture, which means you can add hardware
61 at any level -- database servers, caching servers or web/application servers.
62
63 The framework cleanly separates components such as its database layer and
64 application layer. And it ships with a simple-yet-powerful
65 :doc:`cache framework </topics/cache>`.
66
67 Who's behind this?
68 ==================
69
70 Django was originally developed at World Online, the web department of a
71 newspaper in Lawrence, Kansas, USA. Django's now run by an international
72 `team of volunteers <https://www.djangoproject.com/foundation/teams/>`_.
73
74 How is Django licensed?
75 =======================
76
77 Django is distributed under :source:`the 3-clause BSD license <LICENSE>`. This
78 is an open source license granting broad permissions to modify and redistribute
79 Django.
80
81 Why does Django include Python's license file?
82 ==============================================
83
84 Django includes code from the Python standard library. Python is distributed
85 under a permissive open source license. :source:`A copy of the Python license
86 <LICENSE.python>` is included with Django for compliance with Python's terms.
87
88 Which sites use Django?
89 =======================
90
91 `BuiltWithDjango.com`_ features a constantly growing list of Django-powered
92 sites.
93
94 .. _BuiltWithDjango.com: https://builtwithdjango.com/projects/
95
96 .. _faq-mtv:
97
98 Django appears to be a MVC framework, but you call the Controller the "view", and the View the "template". How come you don't use the standard names?
99 =====================================================================================================================================================
100
101 Well, the standard names are debatable.
102
103 In our interpretation of MVC, the "view" describes the data that gets presented
104 to the user. It's not necessarily *how* the data *looks*, but *which* data is
105 presented. The view describes *which data you see*, not *how you see it.* It's
106 a subtle distinction.
107
108 So, in our case, a "view" is the Python callback function for a particular URL,
109 because that callback function describes which data is presented.
110
111 Furthermore, it's sensible to separate content from presentation -- which is
112 where templates come in. In Django, a "view" describes which data is presented,
113 but a view normally delegates to a template, which describes *how* the data is
114 presented.
115
116 Where does the "controller" fit in, then? In Django's case, it's probably the
117 framework itself: the machinery that sends a request to the appropriate view,
118 according to the Django URL configuration.
119
120 If you're hungry for acronyms, you might say that Django is a "MTV" framework
121 -- that is, "model", "template", and "view." That breakdown makes much more
122 sense.
123
124 At the end of the day, it comes down to getting stuff done. And, regardless of
125 how things are named, Django gets stuff done in a way that's most logical to
126 us.
127
128 <Framework X> does <feature Y> -- why doesn't Django?
129 =====================================================
130
131 We're well aware that there are other awesome web frameworks out there, and
132 we're not averse to borrowing ideas where appropriate. However, Django was
133 developed precisely because we were unhappy with the status quo, so please be
134 aware that "because <Framework X> does it" is not going to be sufficient reason
135 to add a given feature to Django.
136
137 Why did you write all of Django from scratch, instead of using other Python libraries?
138 ======================================================================================
139
140 When Django was originally written, Adrian and Simon spent quite a bit of time
141 exploring the various Python web frameworks available.
142
143 In our opinion, none of them were completely up to snuff.
144
145 We're picky. You might even call us perfectionists. (With deadlines.)
146
147 Over time, we stumbled across open-source libraries that did things we'd
148 already implemented. It was reassuring to see other people solving similar
149 problems in similar ways, but it was too late to integrate outside code: We'd
150 already written, tested and implemented our own framework bits in several
151 production settings -- and our own code met our needs delightfully.
152
153 In most cases, however, we found that existing frameworks/tools inevitably had
154 some sort of fundamental, fatal flaw that made us squeamish. No tool fit our
155 philosophies 100%.
156
157 Like we said: We're picky.
158
159 We've documented our philosophies on the
160 :doc:`design philosophies page </misc/design-philosophies>`.
161
162 Is Django a content-management-system (CMS)?
163 ============================================
164
165 No, Django is not a CMS, or any sort of "turnkey product" in and of itself.
166 It's a web framework; it's a programming tool that lets you build websites.
167
168 For example, it doesn't make much sense to compare Django to something like
169 Drupal_, because Django is something you use to *create* things like Drupal.
170
171 Yes, Django's automatic admin site is fantastic and timesaving -- but the admin
172 site is one module of Django the framework. Furthermore, although Django has
173 special conveniences for building "CMS-y" apps, that doesn't mean it's not just
174 as appropriate for building "non-CMS-y" apps (whatever that means!).
175
176 .. _Drupal: https://www.drupal.org/
177
178 How can I download the Django documentation to read it offline?
179 ===============================================================
180
181 The Django docs are available in the ``docs`` directory of each Django tarball
182 release. These docs are in reST (reStructuredText) format, and each text file
183 corresponds to a web page on the official Django site.
184
185 Because the documentation is :source:`stored in revision control <docs>`, you
186 can browse documentation changes just like you can browse code changes.
187
188 Technically, the docs on Django's site are generated from the latest development
189 versions of those reST documents, so the docs on the Django site may offer more
190 information than the docs that come with the latest Django release.
191
192 How do I cite Django?
193 =====================
194
195 It's difficult to give an official citation format, for two reasons: citation
196 formats can vary wildly between publications, and citation standards for
197 software are still a matter of some debate.
198
199 For example, `APA style`_, would dictate something like:
200
201 .. code-block:: text
202
203 Django (Version 1.5) [Computer Software]. (2013). Retrieved from https://www.djangoproject.com/.
204
205 However, the only true guide is what your publisher will accept, so get a copy
206 of those guidelines and fill in the gaps as best you can.
207
208 If your referencing style guide requires a publisher name, use "Django Software
209 Foundation".
210
211 If you need a publishing location, use "Lawrence, Kansas".
212
213 If you need a web address, use https://www.djangoproject.com/.
214
215 If you need a name, just use "Django", without any tagline.
216
217 If you need a publication date, use the year of release of the version you're
218 referencing (e.g., 2013 for v1.5)
219
220 .. _APA style: https://apastyle.apa.org/
221
222 Where can I find more Django resources?
223 =======================================
224
225 The Steering Council maintains a collection of Django third-party packages,
226 organizations and resources at
227 https://www.djangoproject.com/community/ecosystem/.
228
229 That page will be updated to contain links to various Django content such as
230 podcasts, videos, conferences, blogs, books, and learning resources. It also
231 features popular, robust, community-maintained packages.