django app template

Django App -Vorlage

Die Hälfte des Kampfes um ein erfolgreiches Projekt ist, alles zu organisieren. Dies ist ein GitHub -Template -Repository für eine wiederverwendbare Django -App, die auf PYPI veröffentlicht werden kann.

Merkmale

• Entwicklung mit Schwarz, sodass jeder die Code -Formatierungsregeln erhält, die er verdient
• Entwicklung mit Flake8, also erhalten Menschen, die ED verwenden, Syntaxprüfung
• Entwicklung mit ISORT zum automatischen Sortieren von Importen
• Entwicklung mit MYPY für Typen, die Fehler auf Fehlern fangen
• Testen mit PyTest und Factoryboy:
• Verwalten Sie Versionen mit Bump-my-Version-für semantische oder Kalenderversionsnummern
• Verwalten Sie Abhängigkeiten mit PIP-Tools

Schneller Start

Dies ist ein GitHub -Template -Repository. Erstellen Sie einfach ein neues Repository daraus oder öffnen Sie es in einem Coderaum. Das Repository enthält ein einzelnes Komitee.

Nachdem Sie Ihr Repository überprüft haben, besteht der erste Schritt darin, die App umzubenennen:

./bin/rename-app myapp

Erstellen Sie als nächstes den Virtualenv und installieren Sie alle Abhängigkeiten. Dadurch wird auch die Bibliothek erstellt, die die App enthält:

python3 -m venv .venv
source .venv/bin/activate
pip install --upgrade pip setuptools wheel
pip install pip-tools

Optional. Das Projekt wird mit festgestellten Versionen für die Abhängigkeiten versendet. Wenn Sie auf die neuesten Versionen upgraden möchten, kompilieren Sie die Anforderungsquelldateien neu:

pip-compile --upgrade requirements/dev.in
pip-compile --upgrade requirements/docs.in
pip-compile --upgrade requirements/tests.in

Installieren Sie die Abhängigkeiten:

pip-sync requirements/dev.txt

Führen Sie die Tests aus:

pytest

Führen Sie den Django -Server aus:

./manage.py runserver

Öffnen Sie einen Browser und besuchen Sie http: // localhost: 8000 und voila, wir haben eine Arbeitsstelle. Decken Sie den Einsatz später gut ab.