Test Doc Documentation

Transkript

1 Test Doc Documentation Release 1.0 Andy July 10, 2014

2

3 Contents 1 Einführung 3 2 Setup Tools SSH Basics MVT - Djangos MVC Konzept Routes (URLs) Model Basics Signals View Mixins Template CSS (SCSS) Template Filters Template Tags FAQ Wie kann ich ein neues Projekt aufsetzen oder ein bestehendes aus Bitbucket lokal aufsetzen? Was muss ich tun, wenn ich ein Model verändert oder hinzugefügt habe und dies mittels South in der DB migrieren will? Was tun wenn eine Fehlermeldung erscheint, dass eine Tabelle in der Datenbank fehlt? Was tun wenn eine Fehlermeldung erscheint, dass ein Module nicht gefunden wird oder nicht geladen werden kann? Was muss ich tun, wenn ich sämtliche LiveServer Daten bei mir lokal haben möchte? Was muss ich tun, um die neuste Version im Repository auf den Live-Server zu laden Indices and tables 17 i

4 ii

5 Test Doc Documentation, Release 1.0 Contents: Contents 1

6 Test Doc Documentation, Release Contents

7 CHAPTER 1 Einführung Dieses Dokument dient hauptsächlich dem internen Gebrauch bei impac, darf jedoch ohne weiteres von jedem Entwickler gelesen und mit guten Inputs erweitert werden. Das Dokument dient als Leitfaden bei der Entwicklung mit Django und beinhaltet Firmen spezifische Setups und Anweisungen, welche für aussenstehende vielleicht nicht so sehr interessant sind. Wichtige Stellen für impac Mitarbeiter sind gekennzeichet. Korrekturen sowie Anregungen können gerne an Andy Huber ah@impac.ch gemeldet werden, gerne lassen wir uns eines Besseren belehren. 3

8 Test Doc Documentation, Release Chapter 1. Einführung

9 CHAPTER 2 Setup 2.1 Tools Xcode - AppStore [Entwicklungstools (wird benötigt um zusätzliche Pakete zu kompilieren)] Brew - [OSX Package Installations Tool] PyCharm - [Python Entwicklungsumgebung] git - brew [Source Verwaltungstool] mysql - brew [Datenbank] setuptools - easy_install [Wird benötigt für buildout] SourceTree - [Grafischer git Client] SequelPro - [GUI Tool für MySQL Datenbank] libjpeg - brew [OSX jpeg Library] libpng - brew [OSX PNG Library] 2.2 SSH impac benutzt SSH für die Authentifizierung beim git Repository (Bitbucket) sowie für die Authentifizierung auf sämtlichen Server. Aus Sicherheitsgründen sind sämtliche Username/Passwort authentifizeriungen deaktiviert. SSH Key generieren: ssh-keygen -t rsa -C "your_ @impac.ch" Empty Project Unter kann ein leeres Projekt ausgecked werden. Dies beinhaltet alle Konfigurationen von impac. 5

10 Test Doc Documentation, Release Chapter 2. Setup

11 CHAPTER 3 Basics 3.1 MVT - Djangos MVC Konzept Django ist ein striktes MVC Framework, unterscheided sich jedoch in der Bezeichnung der drei Elemente. Model: Das Model ist die einzige Gemeinsamkeit mit dem herkömlichen MVC Model View: Die Anzeige-Schicht wird im Django mit Template bezeichnet und beinhaltet gängiges HTML mit zusätzlicher Django Template Syntax Controller: Die Controller werden im Django als Views bezeichnet. Somit haben wir ein MVT anstellt von MVC, dies ist jedoch der einzige Unterschied zu einem klassischen MVC Framework 3.2 Routes (URLs) Warning: TODO 7

12 Test Doc Documentation, Release Chapter 3. Basics

13 CHAPTER 4 Model 4.1 Basics Warning: TODO 4.2 Signals Django unterstützt das einhängen von selber geschriebenen Methoden an gewissen Ereignispunkten. Diese Ereignispunkte werden Signalge genannt und sind untenstehend beschrieben, zu welchem Zeitpunkt welches Signal ausgeführt wird. So kann z.b. noch eine spezielle Aktion ausgeführt werden, befor ein Objekt in der Datenbank gelöscht wird pre_delete. Anhängen einer eigenen Methode an einem Signal: from django.db.models import signals signals.<signal-name>.connect(<method>, sender=<modelname>) Signal pre_init post_init pre_save post_save pre_delete post_delete Ereignis Zubeginn bevor das Modelklasse instanziiert wird Am Ende der Initialisierung wenn das Model bereit ist und alle Attribute abgefüllt sind Bevor die Speicherung des Models in die Datenbank erfolgt Am Ende der Speicherung des Models in die Datenbank Bevor die Löschung des Models in der Datenbank erfolgt Am Ende des Löschvorganges in der Datenbank 9

14 Test Doc Documentation, Release Chapter 4. Model

15 CHAPTER 5 View Warning: Beim impac verwenden wir nur Classbased Views und nur in seltenen Ausnahmen Functionbased Views TODO - Häufig verwendet Django Views 5.1 Mixins Mixins erlauben eine Klasse mit beliebigen Funktionen zu erweitern. Mixins werden nie instanziiert sondern geben ihre Funktionen nach unten nur weiter. Mixin erbt immer von der object Klasse von Python. Mixins stehen immer links von der zu erbenden Klasse Nachfolgendes Beispiel erstellt ein Mixin, welches im Context die Varbiale mixin_test setzt.: # Defintion des Mixins class ImpacMixin(object): def get_context_data(self, **kwargs): context = super(impacmixin, self).get_context_data(**kwargs) context["mixin_test"] = True return context # Einbinden unseres Mixins in eine View class ImpacTestView(ImpacMixin, TemplateView): template_name = "test.html" 11

16 Test Doc Documentation, Release Chapter 5. View

17 CHAPTER 6 Template Django bietet die Möglichkeit die Templates direkt in purem HTML zu schreiben. Dank den bestehenden Templatetags sowie der Möglichkeit beliebige weitere Tags selber zu schreiben sind den eigenen Möglichkeiten keine Grenzen gesetzt um die Templates zu gestalten und abzufüllen. Note: Das Template ist im traditionellen MVC Konzept die View In einem Django Template kann immer auf den Context zugegriffen werden. Wenn eigenen Variablen oder Objekte einem Template mitgegeben werden sollen, muss der Context in der View erweitert werden. Beispiel für den Zugriff auf die Variable test_var im Context: {{ test_var }} 6.1 CSS (SCSS) Als CSS Precompiler verwenden wir SASS mit SCSS Syntax um näher an der gängigen CSS Syntax zu sein. Wir unterscheiden vier verschiedene Typen von SCSS Dateien. Die base.scss, welche sämtliche SCSS-Dateien included und später vom Precompiler aufgerufen und gebuildet wird. layout.scss beinhaltet sämtliche Layouts der Seite, wenn es sinnvoll erscheint können hierfür auch mehrere Dateien eingesetzt werden um die Daten zu strukturieren. config.scss enthält sämtliche Variablendeklarationen. font.sccs enthält die Defintion der verschiedenen Schriftarten. Alle unseren internen Projekte sowie auch die meisten Kundenprojekte beinhalten zudem noch das Boostrap responsive Framework, welches auch als SCSS Version erhältlich ist. Note: Alle internen impac Projekte müssen Boostrap beinhalten 6.2 Template Filters Template Filter bieten die Möglichkeit im Template selber Objekte zusätzlich zu bearbeiten. Standard-Filter sind z.b upper / lower, welche eine Variable im Template in Gross- oder Kleinbuchstaben umwandelt. Django bietet die Möglichkeit eigene Filter zu schreiben. Note: Template Filter werden in einem Python Package (templatetags) im root Verzeichnis des Projektes gespeichert Beispiel für das erstellen eines Template Filters: 13

18 Test Doc Documentation, Release #Registrierung des #Typ des Filters -> Filter kann nur auf Strings angwendet werden def upper(value): return value.upper() Beispiel für das anwenden einen Template Filters: {{ title upper }} 6.3 Template Tags Django wird mit einer Vielzahl von Template Tags ausgeliefert. Aufruf einen Template Tags im Template erfolgt immer via {% TAGNAME PARAMETER %}. Nachfolgend eine kurze Auflistung der wichtigsten Template Tags für die tägliche Arbeit bei impac. URL: {% url test_view %} Dieser Tag rendert die URL, welche hinter der Route mit dem Namen test_view steht if: {% if test_array length == 0%} Dieser Tag bietet eine IF Abfrage und kann zusätzlich noch mit einem {% elif... %} oder {% else %} erweitert werden und schliess mit {% endif %} 14 Chapter 6. Template

19 CHAPTER 7 FAQ 7.1 Wie kann ich ein neues Projekt aufsetzen oder ein bestehendes aus Bitbucket lokal aufsetzen? Note: Neue Projekte werden nur mit dem bestehenden impac Buildout-Template-Projekt aufgesetzt. Alle Projekte werden auch lokal mit einer MySQL Datenbank aufgesetzt, damit alle LiveDaten ohne Probleme lokal genutzt werden können. Kopiere die personal config Dateien wie nachfolgend beschrieben: personal.cfg-dist kopieren in personal.cfg personal.py-dist kopieren in personal.py Lokale MySQL Datenbank anlegen für das Projekt und Informationen in personal.py eintragen Lokale Datenbank füllen: bin/django syncdb --all bin/django migrate --fake Init Script ausführen für die Vorbereitung auf buildout:./init.sh Buildout ausführen: bin/buildout -c personal.cfg PyCharm Settings konfigurieren CMD + ; Enable buildout support: <PROJECTROOT>/bin/django Enable django support * project Root: <PROJECTROOT> * settings: <PROJECTROOT>/py_src/project/settings/personal.py * manage script: <PROJECTROOT>/bin/django 15

20 Test Doc Documentation, Release Was muss ich tun, wenn ich ein Model verändert oder hinzugefügt habe und dies mittels South in der DB migrieren will? Zuerst muss eine Schemamigration Datei erzeugt werden, welche die Änderungen des Models beinhaltet: bin/django schemamigration <PROJECTNAME> Schreiben der Migrations Datei in die DB: bin/django migrate <PROJECTNAME> 7.3 Was tun wenn eine Fehlermeldung erscheint, dass eine Tabelle in der Datenbank fehlt? Grund ist, dass ein Model erweitert wurde, jedoch noch kein migrate der South Migration durchgeführt wurde: bin/django migrate 7.4 Was tun wenn eine Fehlermeldung erscheint, dass ein Module nicht gefunden wird oder nicht geladen werden kann? Grund ist, dass unter installed_apps eine App hinzugefügt wurde, welche lokal bei dir noch nicht geladen wurde mittels buildout. Ausführen von Buildout: bin/buildout -c personal.cfg 7.5 Was muss ich tun, wenn ich sämtliche LiveServer Daten bei mir lokal haben möchte? bin/fab set_env:live get_live_data 7.6 Was muss ich tun, um die neuste Version im Repository auf den Live-Server zu laden Note: Anstelle von Live kann auch Stage eingesetzt werden, falls ein Stage-Server konfiguriert wurde. Vorsicht bei dieser Aktion, da der Live-Server verändert wird. bin/fab set_env:live update_server 16 Chapter 7. FAQ

21 CHAPTER 8 Indices and tables genindex modindex search 17