Indexdaten
PL-Nummer 201
LFC-Nummer 13
Erstellung 16.02.2025

Autoren:

Sikoninien
Mitglied des Ältestenrathes
Planteam Servernetzwerk
Pl 201
Softwareprojektstruktur

1 Vorwort

Diese Norm soll die Projektstruktur aller planteaminterner Projekte normen und kann freiwillig auch außerhalb verwendet werden.

2 SQL-Tabellen

Jedes Projekt, welches eine SQL-Datenbank verwendet, muß in seinem Stammverzeichnis eine Datei namens tables.sql führen, die die nöthigen SQL-Befehle enthält, um die Tabellen der Datenbank aufzusetzen. Verwendet ein Projekt mehrere Datenbanken, sollte für jede Datenbank eine eigene Datei verwendet werden, beispielsweise table_users.sql für eine Nutzerdatenbank.

3 Abhängigkeiten

Jedes Projekt sollte im Stammverzeichnis eine PEP-kompatible [1] requirements.txt-Datei führen.

4 Überlegungen

  1. Diese Norm ist für Python-Projekte ausgelegt und sollte beim Aufkommen andersartiger, inkompatibler Projektformen angepaßt werden.
  2. Mit zunehmender Ubiquität des Planteam Package Distributors (PPD) [2] beim Planteam Servernetzwerk im Entwicklungsprozeß von Software könnte es sich künftig anbieten, in dieser Norm auch eine Datei zu verordnen, die sämtliche Abhängigkeiten auf PPD-Ebene irgend auflistet.

5 Referenzen

1 Collins, R., “Dependency specification for Python Software Packages”, PEP 508, November 2015.
2 Wédiaklup, „Planteam Package Distributor“, LFC 14, Februar 2025.

201 — Softwareprojektstruktur

Version 1 (Ändern)
Datum 31.02.2024
Erstellt 16.02.2025
Maintainer wediaklup
Größe 10.39 KiB
Errata (Anzeigen)

Ursprung

Entwurf Erstellt
LFC 13 Erweiterung 001 16.02.25

Versionsgeschichte

Revision Antrag Entwurf Erstellt Übernommen