Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 114 lines (76 sloc) 2.505 kB
bbe685f @dbunskoek Updated README with links to the screencast and example project.
dbunskoek authored
1 ============
2 Django Fiber
3 ============
4
5 Do you want to see a Django Fiber screencast, to get a feel for what it can do for you? Check it out here:
6 http://vimeo.com/ridethepony/django-fiber
7
8 Or, if you want to quickly try out Django Fiber on your machine, install the Django Fiber example project:
9 https://github.com/ridethepony/django-fiber-example
10
9805da6 @dbunskoek Simplified installation, removed some dependencies, improved document…
dbunskoek authored
11 Convinced? Want to use Django Fiber in your own Django project? Then follow the instructions below:
bbe685f @dbunskoek Updated README with links to the screencast and example project.
dbunskoek authored
12
2aae1e2 @dbunskoek first commit
dbunskoek authored
13
14 Installation:
15 =============
16
9805da6 @dbunskoek Simplified installation, removed some dependencies, improved document…
dbunskoek authored
17 We're assuming you are using Django 1.3. If you need to install Django Fiber with an older Django version, you can find instructions in the docs folder.
18
2aae1e2 @dbunskoek first commit
dbunskoek authored
19 ::
20
044d17c @dbunskoek packaged Django Fiber for PyPI
dbunskoek authored
21 $ pip install django-fiber
2aae1e2 @dbunskoek first commit
dbunskoek authored
22
23
24 Requirements:
25 =============
26
044d17c @dbunskoek packaged Django Fiber for PyPI
dbunskoek authored
27 These dependencies are automatically installed:
28
2aae1e2 @dbunskoek first commit
dbunskoek authored
29 ::
30
e197453 @dbunskoek Updated README
dbunskoek authored
31 PIL>=1.1.7
9805da6 @dbunskoek Simplified installation, removed some dependencies, improved document…
dbunskoek authored
32 django-piston==0.2.3rc1
33 django-mptt>=0.4.2
044d17c @dbunskoek packaged Django Fiber for PyPI
dbunskoek authored
34 django-compressor>=0.7.1
208b61b @dbunskoek Removed requirements.txt from pull request, users should add their ow…
dbunskoek authored
35
2aae1e2 @dbunskoek first commit
dbunskoek authored
36
37 Settings:
38 =========
39
40 settings.py
41 -----------
42
43 ::
44
9805da6 @dbunskoek Simplified installation, removed some dependencies, improved document…
dbunskoek authored
45 import django.conf.global_settings as DEFAULT_SETTINGS
46
47 MIDDLEWARE_CLASSES = DEFAULT_SETTINGS.MIDDLEWARE_CLASSES + (
bac4b79 @dbunskoek Updated README reStructuredText to make the README easier to copy/pas…
dbunskoek authored
48 'fiber.middleware.ObfuscateEmailAddressMiddleware',
49 'fiber.middleware.AdminPageMiddleware',
50 'fiber.middleware.PageFallbackMiddleware',
2aae1e2 @dbunskoek first commit
dbunskoek authored
51 )
52
9805da6 @dbunskoek Simplified installation, removed some dependencies, improved document…
dbunskoek authored
53 TEMPLATE_CONTEXT_PROCESSORS = DEFAULT_SETTINGS.TEMPLATE_CONTEXT_PROCESSORS + (
bac4b79 @dbunskoek Updated README reStructuredText to make the README easier to copy/pas…
dbunskoek authored
54 'django.core.context_processors.request',
55 'fiber.context_processors.page_info',
2aae1e2 @dbunskoek first commit
dbunskoek authored
56 )
57
58 INSTALLED_APPS = (
bac4b79 @dbunskoek Updated README reStructuredText to make the README easier to copy/pas…
dbunskoek authored
59 ...
9805da6 @dbunskoek Simplified installation, removed some dependencies, improved document…
dbunskoek authored
60 'django.contrib.staticfiles',
61 'piston',
bac4b79 @dbunskoek Updated README reStructuredText to make the README easier to copy/pas…
dbunskoek authored
62 'mptt',
63 'compressor',
64 'fiber',
65 ...
2aae1e2 @dbunskoek first commit
dbunskoek authored
66 )
67
68 import os
e197453 @dbunskoek Updated README
dbunskoek authored
69 BASE_DIR = os.path.abspath(os.path.dirname(__file__))
70
71 STATIC_ROOT = os.path.join(BASE_DIR, 'static')
72 STATIC_URL = '/static/'
9805da6 @dbunskoek Simplified installation, removed some dependencies, improved document…
dbunskoek authored
73 STATICFILES_FINDERS = DEFAULT_SETTINGS.STATICFILES_FINDERS + (
bac4b79 @dbunskoek Updated README reStructuredText to make the README easier to copy/pas…
dbunskoek authored
74 'compressor.finders.CompressorFinder',
044d17c @dbunskoek packaged Django Fiber for PyPI
dbunskoek authored
75 )
2aae1e2 @dbunskoek first commit
dbunskoek authored
76
77 urls.py
78 -------
79
80 ::
81
851bba0 @dbunskoek Added settings import to urls.py documentation
dbunskoek authored
82 from django.conf import settings
83
84 urlpatterns = patterns('',
bac4b79 @dbunskoek Updated README reStructuredText to make the README easier to copy/pas…
dbunskoek authored
85 ...
86 (r'^api/v1/', include('fiber.api.urls')),
87 (r'^admin/fiber/', include('fiber.admin_urls')),
88 (r'^jsi18n/$', 'django.views.i18n.javascript_catalog', {'packages': ('fiber',),}),
89 ...
851bba0 @dbunskoek Added settings import to urls.py documentation
dbunskoek authored
90 )
2aae1e2 @dbunskoek first commit
dbunskoek authored
91
e197453 @dbunskoek Updated README
dbunskoek authored
92 if settings.DEBUG:
9805da6 @dbunskoek Simplified installation, removed some dependencies, improved document…
dbunskoek authored
93 urlpatterns += patterns('django.contrib.staticfiles.views',
bac4b79 @dbunskoek Updated README reStructuredText to make the README easier to copy/pas…
dbunskoek authored
94 url(r'^static/(?P<path>.*)$', 'serve'),
95 )
e197453 @dbunskoek Updated README
dbunskoek authored
96
2aae1e2 @dbunskoek first commit
dbunskoek authored
97
98 Post-installation:
99 ==================
100
101 Create database tables::
102
103 $ python manage.py syncdb
104
044d17c @dbunskoek packaged Django Fiber for PyPI
dbunskoek authored
105 All static Fiber files need to be symlinked in (or copied to) your media folder::
2aae1e2 @dbunskoek first commit
dbunskoek authored
106
044d17c @dbunskoek packaged Django Fiber for PyPI
dbunskoek authored
107 $ python manage.py collectstatic --link
2aae1e2 @dbunskoek first commit
dbunskoek authored
108
109
9805da6 @dbunskoek Simplified installation, removed some dependencies, improved document…
dbunskoek authored
110 Further documentation:
111 ======================
2aae1e2 @dbunskoek first commit
dbunskoek authored
112
9805da6 @dbunskoek Simplified installation, removed some dependencies, improved document…
dbunskoek authored
113 You can find usage instructions, and other documentation, in the docs folder.
Something went wrong with that request. Please try again.