ne pas inclure /docs/_build
[auf-django-sdk.git] / docs / index.rst
1
2 auf-django-sdk
3 ==============
4
5 Kit de développement Django ou désignés par le sigle anglais SDK (Software Development Kit)
6 est un ensemble d'outils permettant aux développeurs de créer des applications de type défini
7 dans notre cas Django.
8
9 Installation
10 ------------
11
12 Debian::
13
14   sudo apt-get install auf-django-sdk
15
16 Paquets Debian
17 --------------
18
19 auf-django-auf-sdk
20
21   Contient les modules Python et Django développé par l'AUF.
22
23 auf-django14-base-sdk
24
25   Contient les modules de base pour les sites Django de l'AUF
26
27 auf-django14-extra-sdk
28
29   Contient les modules d'extra pour les sites Django de l'AUF
30
31 auf-django14-dev-sdk
32
33   Contient les modules d'aide au développement des sites Django de l'AUF
34
35 Configuration
36 -------------
37
38 Des fichiers de configuration Django pour les modules communéments
39 utilisés sont placé dans le répertoire `configurations/`.
40
41 django14_auf
42
43 django14_base
44
45 django14_extra
46
47 django14_auf_admin
48
49 django14_auf_dev
50
51 Utilisation
52 -----------
53
54 Exemple d'arboressance::
55
56   /srv/
57      auf-django-sdk/
58         sdk/
59            django14_auf/
60            django14_base/
61            django14_dev/_
62      mon_site_site/
63         mon_site/
64         externals_apps/
65
66
67 Exemple de fichier `manage.py`
68
69 .. code-block:: python
70
71     #!/usr/bin/env python
72     import os
73     import sys
74
75     sys.path.append('./mon_site/')
76     sys.path.append('./external_apps/')
77
78     # Pour le dev localement
79     sys.path.append('../auf-django-sdk/sdk/django14_auf/')
80     sys.path.append('../auf-django-sdk/sdk/django14_base/')
81     sys.path.append('../auf-django-sdk/sdk/django14_dev/')
82
83     # Pour la production
84     sys.path.append('/var/lib/auf-django-sdk/django14_auf/')
85     sys.path.append('/var/lib/auf-django-sdk/django14_base/')
86
87     if __name__ == "__main__":
88         settings_module = "mon_site.settings"
89
90         os.environ.setdefault("DJANGO_SETTINGS_MODULE", settings_module)
91         from django.core.management import execute_from_command_line
92         execute_from_command_line(sys.argv)
93