/
gettingstarted.txt
77 lines (49 loc) · 1.72 KB
/
gettingstarted.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
.. _ref-gettingstarted:
===============
Getting started
===============
This document is designed to get you up and running with mimesis. This app is
designed for use with Django_, however, can be used with Pinax_. Pinax can
provide some extra components which will enhance the functionality of mimesis.
Those extra components are designed for Django too and Pinax simply brings
them together.
Prerequisites
=============
These are the requirements to run mimesis:
* Python **2.5+** (Python 3.x is **not** supported yet)
* Django **1.2+**
* djagno-taggit **0.8.0**
Some packages that will be immensely useful, but not required, are:
* sorl-thumbnail **3.2.5**
Installation
============
To install mimesis use pip_:
.. code-block:: none
pip install mimesis
Add mimesis to your ``INSTALLED_APPS``:
.. code-block:: python
INSTALLED_APPS = [
# ...
"mimesis",
"taggit",
]
Hook up mimesis to your URLconf:
.. code-block:: python
urlpatterns = patterns("",
# ...
url(r"^photos/", include("mimesis.urls"))
)
This is largely all you need to do to get mimesis setup in your project.
Continue reading on to learn more about how to use mimesis.
Usage
=====
If you want to use a flash uploader, like ``swfupload`` with jQuery's uploadify_
you'll need to set ``MIMESIS_USE_FLASH_UPLOAD`` to ``True`` so that the the
upload handler will do the right thing with regards to session data since the
user's authenticated session cookie will not be sent on the Flash POST.
.. code-block:: python
MIMESIS_USE_FLASH_UPLOAD = True
.. _Django: http://www.djangoproject.com/
.. _Pinax: http://pinaxproject.com/
.. _pip: http://pip.openplans.org/
.. _uploadify: http://www.uploadify.com/