sji 0.2.1

SJI - Eine einfache Python-Bibliothek für Job-Initialisierung

SJI

Eine einfache Python-Bibliothek für die Initialisierung von Jobs/Skripten (Logging, Konfiguration, Ordnerstruktur).

Installation

pip install sji

Verwendung

from sji import SimpleJobInit, get_script_version

# __file__ an SimpleJobInit übergeben
sji = SimpleJobInit(__file__)

# Logger verwenden
sji.logger.info("Starte Job...")

# Konfiguration lesen (INI)
cfg = sji.config
value = cfg.get('section', 'key', fallback='default')

# Persistente Datei-Pfade erhalten
csv_path = sji.get_persistent_file_path('csv')

# Temporäre Datei-Pfade erhalten
tmp_path = sji.get_tmp_file_path('work.tmp')

# Versionen ermitteln
sji.logger.info(f"script_version={sji.get_job_script_version(include_git_tag=True)}")
sji.logger.info(f"config_file_hash={sji.get_config_file_hash()}")
sji.logger.info(f"config_file_version={sji.get_config_file_version()}")

# Top-Level-Funktion (unabhängig von der Klasse):
script_version = get_script_version(__file__, include_git_tag=True)

# Konfiguration mit Maskierung loggen
sji.log_config(secret_fields=["password", "db_password", "api_key", "token"]) 

Dabei werden automatisch erzeugt/genutzt:

• logs/.log (mit optionaler Rotation)
• tmp/ Verzeichnis
• .config.ini für Einstellungen

Minimalbeispiel für die INI-Datei

Datei: <skriptname>.config.ini im selben Verzeichnis wie das Skript

[logging]
level = INFO
log_rotation_when = midnight
log_rotation_backup_count = 7

[section]
key = some-value

API

Klasse: SimpleJobInit

• SimpleJobInit(script_file_path: str)
  • Initialisiert Logging, lädt/prüft INI-Config, erzeugt Ordner (logs, tmp)
• Eigenschaften
  • logger: konfigurierter logging.Logger
  • config: configparser.ConfigParser
• Methoden
  • get_tmp_file_path(file_name: str) -> str: Pfad im tmp/-Verzeichnis
  • get_persistent_file_path(file_ending: str) -> str: Pfad <skriptname>.<file_ending>
  • get_job_script_version(include_git_tag: bool = False) -> str: ermittelt Skriptversion (Git/FS)
  • get_config_file_hash() -> str: SHA-256 Hash der INI-Datei
  • get_config_file_version() -> str: cfg_<UTC-Zeit>_<sha256> basierend auf Datei-mtime und Hash
  • log_config(secret_fields) -> None: loggt INI-Inhalt, maskiert definierte Felder (case-insensitive)
  • get_postgres_sqlalchemy_engine(db_config): baut SQLAlchemy-Engine aus INI-Werten

Top-Level-Funktion

• get_script_version(script_file_path: str, include_git_tag: bool = False) -> str
  • Wie get_job_script_version, aber als freie Funktion für eigenständige Nutzung

Lizenz

MIT-Lizenz - siehe LICENSE für Details.

• Project build with support of AI (Cursor IDE).