| 1 | | = Django source-code repository, wiki and bug-report system = |
| 2 | | |
| 3 | | Django is available open-source under the [http://code.djangoproject.com/file/django/trunk/LICENSE BSD license]. |
| 4 | | |
| 5 | | == Browsing code online == |
| 6 | | |
| 7 | | * [/browser/django/trunk/ Browse source]: See the full code via a Web interface. |
| 8 | | * [/timeline/ Timeline]: Keep track of recent changes. |
| 9 | | * See our [http://www.djangoproject.com/download/ download page] for download instructions. |
| 10 | | |
| 11 | | == Getting involved == |
| 12 | | |
| 13 | | * [http://www.djangoproject.com/documentation/contributing/ How to contribute to Django]: The lowdown on how our community works. |
| 14 | | * [http://code.djangoproject.com/wiki/Reports Tickets]: View active tickets, make bug reports and contribute feature requests. |
| 15 | | * [wiki:LittleEasyImprovements Little, easy improvements]: Get your feet wet by taking on one of these small tasks. |
| 16 | | * [http://www.djangoproject.com/documentation/contributing/#reporting-security-issues How to report security issues]. |
| 17 | | |
| 18 | | == Sites using Django == |
| 19 | | |
| 20 | | * [wiki:DjangoPoweredSites Django-powered sites]: List your Django powered site(s) here! |
| 21 | | |
| 22 | | == Branches in development == |
| 23 | | |
| 24 | | Currently, a number of branches of development aim to implement new features in Django. Each of these may or may not be stable, but we encourage you to test them out and give feedback to branch maintainers. Each branch has its own page. |
| 25 | | |
| 26 | | * [wiki:NewformsAdminBranch newforms-admin]: A small refactoring of Django's admin site to use the [http://www.djangoproject.com/documentation/newforms/ newforms library] rather than automatic manipulators, allowing for additional customization of admin-site functionality. |
| 27 | | * [wiki:ModelInheritance]: Write-up discussing how inheritance/subclassing of models should work. Currently this is not implemented in the development version of Django, so if you need model subclassing stick to one of the older stable releases or use workarounds like one-to-one relationships. |
| 28 | | * [wiki:SchemaEvolution]: This is a new feature, under development as a project for the 2006 Summer of Code. |
| 29 | | * [wiki:RowLevelPermissions]: Currently Django's permission system only works at the level of an entire model -- e.g., user "Bob" has access to add flatpages and edit users. This Summer of Code project will extend the permission system to be much more fine-grained, so permissions will be able to be assigned per object instead of per model (so, for example, user "Bob" could be given permission to edit only flatpage number 24 and user number 12, instead of all flatpages and all users). |
| 30 | | * [wiki:GenericAuthorization]: A more flexible authorization system for Django. The new system should allow for ACL's, role-based systems, and Django's current model-level permissions. |
| 31 | | * [wiki:FullHistory]: A "full content history" implementation with compare, revert, etc. A SoC 2006 project. |
| 32 | | * [wiki:TextIndexingAbstractionLayer]: An abstraction layer for full-text indexing and search engines such as Lucene, Xapian, and Hyper Estraier. Also known as Merquery, this Summer of Code project will most likely be placed in contrib.search. |
| 33 | | * Generic relations: a "generic foreign key" feature is currently under development, but not yet completed. There is no support for it yet in the admin application, and it is probably unwise to attempt to use it in a production application. |
| 34 | | |
| 35 | | == Descriptions of major changes to the codebase == |
| 36 | | |
| 37 | | * [wiki:BackwardsIncompatibleChanges Backwards-incompatible changes]: Comprehensive list of backwards-incompatible changes made since first public release. |
| 38 | | * [wiki:RemovingTheMagic Removing the magic]: The magic-removal branch was merged to trunk in May 2006 ([2809]). |
| 39 | | * [wiki:NewAdminChanges New-admin changes]: The new-admin branch was merged to trunk in November 2005 ([1433]). |
| 40 | | |
| 41 | | == Example applications (with source code/templates) == |
| 42 | | |
| 43 | | * [http://code.google.com/hosting/search?q=label:django Django-based projects at Google Code Hosting]. |
| 44 | | * [/browser/djangoproject.com/django_website/ djangoproject.com]: See the full code and templates for the Django-powered portions of this site (e.g., everything except the ticket system). The Python code is available under the BSD license, but the templates are copyrighted by World Online and shouldn't be copied. |
| 45 | | * [http://code.google.com/p/diamanda/ Diamanda Wiki and MyghtyBoard Forum]: A wiki and forum. GPL. |
| 46 | | * [https://svn.greenpeace.org/repositories/custard/production/ Custard/Melt]: A work-in-progress community Web app developed by Greenpeace. LGPL. |
| 47 | | * [http://simon.bofh.ms/cgi-bin/trac-django-projects.cgi/wiki/DjangoGallery Django Photo Gallery]: A "gallery with a twist" by Georg Bauer. |
| 48 | | * [http://simon.bofh.ms/cgi-bin/trac-django-projects.cgi/wiki/CmsProject]: A simple CMS by Georg Bauer. (Powers the site [http://rfc1437.de/].) |
| 49 | | * [http://simon.bofh.ms/cgi-bin/trac-django-projects.cgi/wiki/IrcLogger]: An IRC logger by Georg Bauer. (Powers the [http://simon.bofh.ms/logger/django/ Django IRC logs].) |
| 50 | | * [http://zyons.com Zyons]: A forum/community application. |
| 51 | | * [http://workstyle-py.sourceforge.net/ WorkStyle]: A "Get Things Done" to-do list management application. A [http://django.everes.net/WorkStyle/ sandbox] is available, too. |
| 52 | | * [http://www.carcosa.net/jason/software/django/stockphoto/ Stockphoto]: A simple photo gallery by Jason !McBrayer. |
| 53 | | * [http://www.feedjack.org/ Feedjack]: A planet/feed aggregator by Gustavo Picón. Sample sites: [http://django.feedjack.org/], [http://gnome.feedjack.org/], [http://google.feedjack.org/]. |
| 54 | | * [http://dpaste.com/about/ Pastebin]: A pastebin application driven completely by generic views, no custom view code. |
| 55 | | * [http://ff-firmware.quamquam.org/trac/wiki/FFSomething FFSomething]: A suite for managing open wireless mesh networks |
| 56 | | * [https://svn.wamber.net/projects/bookmaker BookMaker]: An open-source Web application for managing small parimutuel betting pools ([https://svn.wamber.net/projects/bookmaker/browser Browse source]). |
| 57 | | * [http://riseproject.sourceforge.net/ RISE Project (Resources and Information for Success in Education)]: A project to manage and publish academic catalog information, including programs, courses, and schedules. BSD. |
| 58 | | * [http://www.coulix.net/blog/2006/aug/17/ip-country-flags-django-comments/ IP-to-country application]: Allows you to get the country flag of comments. |
| 59 | | * [http://tools.assembla.com/notmm/wiki notmm]: A multi-purpose application toolkit. (Apache License Version 2.0 and BSD-style license compatible.) |
| 60 | | * [http://trac.dedhost-sil-076.sil.at/trac/filebrowser/wiki FileBrowser] - An extension to the Django admin interface. |
| 61 | | * [http://trac.ambitone.com/ambidjangolib/wiki/djac djac] - a Django app which collects tickets from multiple [http://trac.edgewall.org/ trac] sites into one page |
| 62 | | * [svn://wowsms.ru/homepage/trunk/ Blog] - weblog, portfolio, cv, Sample site: [http://mezz.spb.ru] |
| 63 | | |
| 64 | | == Contributed documentation and examples == |
| 65 | | |
| 66 | | Note that none of these documents are "official" and may be incorrect. If you find errors, please correct them. |
| 67 | | |
| 68 | | === General === |
| 69 | | |
| 70 | | * [http://djangoapi.quamquam.org Django API]: Autogenerated Django API documentation |
| 71 | | * [http://blixtra.org/blog/2006/07/17/top-30-django-tutorials-and-articles/ Compilation of Tutorials]: Intended to be a complete and concise list of Django tutorials |
| 72 | | * CookBook: Code recipes. |
| 73 | | * CommonPitfalls: Common developer errors, gotchas, etc. |
| 74 | | * DocumentationSuggestions: A place to put docs that you wish ''you'' could have found while learning |
| 75 | | * [wiki:DosAndDontsForApplicationWriters Do's and Dont's for application writers]: how to make an application that is easy to distribute |
| 76 | | * [wiki:MindmapCheatsheetForGenericViewsAPI Mindmap Cheat Sheet for the Generic Views API] as described in [http://www.djangobook.com/en/beta/chapter09/ The Django Book (chapter 9)]. |
| 77 | | * FormField documentation for Manipulators |
| 78 | | * ExtendedUserModel: How to extend the auth systems's User class to contain extra data. (Warning: kludge!) |
| 79 | | * [wiki:CustomFormFields Making Custom form fields]: Adventures in making new form fields. |
| 80 | | * [wiki:CustomUploadAndFilters Custom Upload Fields with Template Filters]: extra features for upload fields. |
| 81 | | * [wiki:DeveloperDocs Developer Documentation]: Documentation about the internals of Django. |
| 82 | | * [wiki:ContributedMiddleware User-contributed middleware] |
| 83 | | * [http://trac.studioquattro.biz/djangoutils/ Djangoutils]: Miscellaneous Django utilities. |
| 84 | | * [wiki:InitialSQLDataDiangoORMWay Initial SQL data using Django ORM]: How to do it. |
| 85 | | * [wiki:Django_and_PureFTPd Using Django and PureFTPd]: How to use Django's user database in PureFTPd. Surprisingly painless. |
| 86 | | * [http://www.zbyte64.com/code.shtml Django & Open Office]: An example of how to use Django and Open Office to do advance document templating. |
| 87 | | |
| 88 | | === Installing and configuring Django === |
| 89 | | |
| 90 | | * [wiki:ServerArrangements Server arrangements]: How to use Django with FCGI, Twisted, etc. |
| 91 | | * [wiki:SetupOnTiger Setup on Mac OS X Tiger]: Includes installing python 2.4 (which isn't required), the latest version of postgresql, and psycopg. |
| 92 | | * [wiki:WindowsInstall] - install django on Windows in 5 minutes (using sqlite and the internal webserver) |
| 93 | | * [http://manuals.textdrive.com/read/book/15 Django, lighttpd and FastCGI]: A book-like documentation about running django with Lighttpd |
| 94 | | * [wiki:MovablePythonInstall] - install Django on a USB stick using Movable Python |
| 95 | | * [wiki:DjangoOnAStick] - Install Django on a USB stick. |
| 96 | | |
| 97 | | === Development environment === |
| 98 | | |
| 99 | | * [wiki:SimpleBashScriptToSetupDevelopmentEnvironment Simple Bash Script To Setup Development Environment]: An example of how to set up your development environment. |
| 100 | | * [wiki:DjangoSettingsBashFunction 'django-settings' Bash function]: Save the typing of DJANGO_SETTINGS_MODULE. |
| 101 | | * [wiki:UsingVimWithDjango Django development with Vim]: Hints and tips for using the Vim editor. |
| 102 | | * [wiki:PythonScriptForParsingSettings A python script for parsing settings.py]: A small python script can be used to read, modify, save settings.py file. |
| 103 | | * [wiki:PythonScriptForParsingUrlConf A python script for parsing urls.py]: A small python script can be used to read, modify, save urls.py file. |
| 104 | | * [wiki:ProfilingDjango Profiling Django]: How to use the Python hotshot profiler with Django |
| 105 | | * [wiki:GreasemonkeyScriptForSmallTitles Greasemonkey script for djangoproject.com]: Shortens titles to faciliate better tab browsing of Django's documentation |
| 106 | | * [wiki:SimplePrintAppForDebugging]: A simple print app for debugging. |
| 107 | | * [wiki:DbDumpScript]: A python script can be used for dumpping and loading data from database. |
| 108 | | |
| 109 | | === Templates === |
| 110 | | |
| 111 | | * ExtendingAdminTemplates |
| 112 | | * [wiki:TemplateTagsCheatSheet] - A quick list of all the template tags. |
| 113 | | * [wiki:MyghtyTemplatesInDjango Using Myghty Templates in Django] - How to use Myghty templates in Django |
| 114 | | * [http://www.zope.org/Members/shh/DjangoPageTemplates Zope3 Page Templates for Django] – Add-on allowing to use ZPT in Django |
| 115 | | * [ticket:2440 PHP template loader] - Integrate Django templates into an existing PHP based site |
| 116 | | * [http://126.pl/cheetah.tar.bz Cheetah template for django]: Generic views + cheetah's admin functions. Contact dj@126.pl. (BROKEN LINK) |
| 117 | | |
| 118 | | === Code examples === |
| 119 | | |
| 120 | | * [wiki:ajax_shop_basket Ajax/DHTML shopping basket in Django example] |
| 121 | | * [wiki:contentBBCode_parser ContentBBcode Parser] - How-to make pluggable special-tag parser |
| 122 | | * [wiki:reading_baldurs_gate_binary_files Reading Binary Files] - How to read Baldurs Gate II character files and display data about the character |
| 123 | | * [wiki:AjaxDjangoDojoForm Ajax and Django, using Dojo] How to submit a form using Ajax with Dojo. |
| 124 | | * [wiki:AjaxDjangoYUI Ajax and Django, using YUI] How to make ajax work with Django with Yahoo! UI Library. |
| 125 | | * [http://www.carthage.edu/webdev/?p=12 LDAP Django Auth Backend]: Dead-Simple LDAP in Django with Backends |
| 126 | | * [wiki:AddDojoEditor Add Dojo Editor]: How to add a rich-text editor to administration pages with Dojo. |
| 127 | | * [wiki:CustomWidgetsTinyMCE Custom TinyMCE Widget]: How to create a custom TinyMCE widget using django.newforms |
| 128 | | * [wiki:ScaffoldScript Simple 'scaffolding']: Spew out simple form fields as a base for modification |
| 129 | | * [wiki:Scaffolding More about scaffolding]: Spew out simple forms for your whole app, including automated urls |
| 130 | | * [wiki:GenerateGenericURLs Generic URL Generator]: Generate URLs when using generic views |
| 131 | | * [wiki:ModelMiddleware Model 'middleware']: Add pre/post save/delete callbacks to any model. |
| 132 | | * [wiki:ManipulatorScript Simple Custom Manipulators]: Spews out a custom manipulator for your model, primed and ready for tweaking. |
| 133 | | * [wiki:AutoAllApps Auto All-Apps Module]: Simple package with all the installed app modules underneith it. |
| 134 | | * [wiki:SafeSettingsContextProcessor Safe Settings context processor]: Provide template access to your settings variables. |
| 135 | | * [wiki:FormGenScript Form Generator]: Simple script to spew out a newform from a given model. |
| 136 | | |
| 137 | | === Web services/APIs === |
| 138 | | |
| 139 | | * [wiki:searchengine A Google search engine front end in Django tutorial] |
| 140 | | * [wiki:XML-RPC] Example of doing XML-RPC in Django |
| 141 | | * [wiki:JSON-RPC] Example of doing JSON-RPC in Django |
| 142 | | * [wiki:WebServices WebServices]: An example showing how to access a web service (Amazon.com) using Python. |
| 143 | | * [wiki:FlickrIntegration] - One way of integrating flickr with Django |
| 144 | | * [wiki:GoogieSpell] - Spell checking [http://www.djangoproject.com/documentation/model_api/#textfield TextField]s with [http://orangoo.com/labs/GoogieSpell/ GoogieSpell]. |
| 145 | | |
| 146 | | === Tutorials on the Web === |
| 147 | | |
| 148 | | * [http://step-inside.org/blog/2006/jul/01/django_blog_notifying_comments_email/ Django Blog: Notifying about new comments by email] |
| 149 | | * [http://www.mercurytide.com/knowledge/white-papers/django-full-text-search Extending Django's database API to include full-text search] |
| 150 | | * [http://fallingbullets.com/blog/2006/aug/06/wordpress-clone-27-seconds-part-1-40/ WordPress Clone in 27 Seconds] |
| 151 | | * [http://www.wilsonminer.com/posts/2006/may/10/are-you-generic/ Are you generic?] |
| 152 | | * [http://www.rossp.org/blog/2006/jul/11/sending-e-mails-templates/ Sending E-Mails via Templates] |
| 153 | | * [http://www2.jeffcroft.com/2006/jul/14/django-admin-your-php-app/ Django admin for your PHP app?] |
| 154 | | * [http://www.b-list.org/weblog/2006/07/16/django-tips-hacking-freecomment Hacking FreeComment] |
| 155 | | * [http://www.b-list.org/weblog/2006/06/28/django-tips-difference-between-blank-and-null The difference between blank and null] |
| 156 | | * [http://www.rossp.org/blog/2006/jun/23/building-blog-django-4/ Using Django’s TemplateTags] |
| 157 | | * [http://lukeplant.me.uk/blog.php?id=1107301641 A Django website that took (a lot) more than 20 minutes] |
| 158 | | * [http://www.pointy-stick.com/blog/2006/07/03/django-tips-forms-multiple-inline-objects/ Forms With Multiple Inline Objects] |
| 159 | | * [http://www.pointy-stick.com/blog/2006/06/29/django-tips-extending-generic-views/ Extending Generic Views] |
| 160 | | * [http://www.b-list.org/weblog/2006/06/14/django-tips-template-context-processors Template context processors] |
| 161 | | * [http://www.pointy-stick.com/blog/2006/06/14/custom-sql-django/ Custom SQL In Django] |
| 162 | | * [http://www.b-list.org/weblog/2006/06/13/how-django-processes-request How Django processes a request] |
| 163 | | * [http://www.b-list.org/weblog/2006/06/07/django-tips-write-better-template-tags Write better template tags] |
| 164 | | * [http://www.b-list.org/weblog/2006/06/06/django-tips-extending-user-model Extending the User model] |
| 165 | | * [http://feh.holsman.net/articles/2006/06/03/django-contenttype Django’s Undocumented contenttype app] |
| 166 | | * [http://www.b-list.org/weblog/2006/05/21/django-gzip-and-wsgi Django, gzip and WSGI] |
| 167 | | * [http://www2.jeffcroft.com/2006/may/02/django-non-programmers/ Django for non-programmers] |
| 168 | | * [http://www2.jeffcroft.com/2006/feb/25/django-templates-the-power-of-inheritance/ Django Templates: The Power of Inheritance] |
| 169 | | * [http://www2.jeffcroft.com/2006/feb/21/django-templates-an-introduction/ Django Templates: An Introduction] |
| 170 | | * [http://www2.jeffcroft.com/2006/may/11/django-dreamhost/ Setting up Django on Dreamhost] |
| 171 | | * [http://thinkhole.org/wp/2006/04/03/django-on-windows-howto/ Django on Windows HOWTO] |
| 172 | | * [http://lukeplant.me.uk/blog.php?id=1107301634 Django Admin Hack - Fields varying with user permissions] |
| 173 | | * [http://www.carcosa.net/jason/blog/computing/django/gotchas-2006-04-19 Some django gotchas] |
| 174 | | * [http://rfc1437.de/page/django-templates-are-not-limited/ Django Templates are not limited] |
| 175 | | * [http://www-128.ibm.com/developerworks/linux/library/l-django/index.html Develop for the Web with Django and Python] |
| 176 | | * [http://code.djangoproject.com/wiki/AJAXWidgetComboBox An AJAX Select Widget for Django] |
| 177 | | * [http://code.djangoproject.com/wiki/UsingFreeComment Using Django’s Free Comments] |
| 178 | | * [http://grindhaug.org/?p=157 MochiKit and Django] |
| 179 | | * [http://www.oreillynet.com/onlamp/blog/2006/06/django_rss_made_stupidly_simpl.html RSS made stupidly simple] |
| 180 | | * [http://toolmantim.com/article/2006/5/31/installing_django_on_osx Installing Django on OSX] |
| 181 | | |
| 182 | | === Presentations === |
| 183 | | |
| 184 | | * [wiki:SnakesAndRubiesTranscript Snakes and Rubies Transcript]: Currently a partial transcript of the Snakes and Rubies meeting videos. |
| 185 | | * DjangoScreencasts: Official and unofficial screencasts showing Django development in action. |
| 186 | | * [http://itmaurer.com/clepy/htdocs/media/presentation/presentation.html Python Web development with Django]: A presentation in pseudo-!PowerPoint format that provides a good overview. |
| 187 | | |
| 188 | | == Resources in other languages == |
| 189 | | |
| 190 | | * [wiki:TranslateDocumentation Translation grid for documents in '/docs']: A work in progress translation project. |
| 191 | | * [wiki:DocItTutorial01 Italian Django Tutorial]: An Italian Django tutorial step by step. [Italian] |
| 192 | | * [wiki:ChineseDjangoTutorial Chinese Django Tutorial]: A Chinese Django tutorial step by step. [Chinese] |
| 193 | | * [http://blog.zabiello.com/articles/category/django Jarosław Zabiełło Blog]: Various Django tips and tutorials [Polish] |
| 194 | | * [http://www.python.rk.edu.pl Biblioteka Pythona]: Polish documentation and examples [Polish] |
| 195 | | * [http://www.biologeek.com/journal/index.php/Web-frameworks French translation of Django documentation] |
| 196 | | * [wiki:DjangoBrasil Django Brazil]: To organize suggestions and ideias. |
| 197 | | |
| 198 | | == Under discussion == |
| 199 | | |
| 200 | | * [wiki:ModelInheritance Model Inheritance]: Subclassing and model inheritance. |
| 201 | | * [wiki:VersionOneFeatures Version One features] |
| 202 | | * [wiki:Localization Localization (l10n)] |
| 203 | | * [wiki:UnicodeInDjango Streamlining Unicode Usage] |
| 204 | | * [wiki:AJAX AJAX and Django] |
| 205 | | * [wiki:BetterErrorMessages Better Error Messages]: Documenting situations where better error messages would improve the experience of developing with Django |
| 206 | | * [wiki:MultipleDatabaseSupport Multiple Database Support]: Adding support for multiple database connections |
| 207 | | * [wiki:AutoEscaping]: Auto escaping of variables by templates |
| 208 | | |
| 209 | | == Community == |
| 210 | | |
| 211 | | * [wiki:DevelopersForHire Developers for hire]: Community members available to do Django work. |
| 212 | | * [wiki:DjangoFriendlyWebHosts Django-friendly Web hosts] |
| 213 | | * [http://www.djangoproject.com/community/badges/ Official Django badges] |
| 214 | | * [http://www.djangoproject.com/community/logos/ Official Django logos] |
| 215 | | * [wiki:DjangoUsers DjangoUsers]: User community about django. |
| 216 | | * [http://www.pybots.org/ Pybots]: Continuous integration testing of the Django development trunk against latest changes to the Python 2.5 maintenance branch and 2.6 development trunk. |
| | 1 | <img src="http://upload.wikimedia.org/wikipedia/en/2/22/Robertmaschio4x15.jpg" /> |