Better project and target structure; bump version: 0.1.5

Author: manuelkiessling

.github/workflows/release.yml

@@ -34,14 +34,6 @@ jobs:
       - name: Build package
         run: python -m build
 
-      - name: Create additional assets archive
-        run: |
-          mkdir -p release_files/conf
-          cp conf/*.dist release_files/conf/
-          cd release_files
-          zip -r ../additional_assets.zip .
-          cd ..
-
       - name: Get version from tag
         id: get_version
         run: echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT
@@ -56,4 +48,3 @@ jobs:
           files: |
             dist/*.whl
             dist/*.tar.gz
-            additional_assets.zip

.gitignore

@@ -14,8 +14,8 @@
 # Keep .idea/modules.xml
 
 venv/
-platform_problem_monitoring_core.conf
-conf/lucene_query.json
+main.conf
+etc/lucene_query.json
 
 # Python package build artifacts
 *.egg-info/

README.md

@@ -59,7 +59,7 @@ This tool is ideal if:
 
 4. **Create a configuration file:**
    ```bash
-   cp src/platform_problem_monitoring_core.conf.dist platform_problem_monitoring_core.conf
+   cp etc/main.conf.dist /etc/main.conf
    ```
 
 5. **Edit the configuration:**
@@ -83,7 +83,7 @@ This tool is ideal if:
 
 6. **Set up the Elasticsearch query:**
    ```bash
-   cp src/lucene_query.json.dist lucene_query.json
+   cp etc/lucene_query.json.dist etc/lucene_query.json
    ```
 
    This default query looks for error messages while filtering out noise:
@@ -111,7 +111,7 @@ This tool is ideal if:
 
 7. **Run the tool:**
    ```bash
-   ./src/run.sh ./platform_problem_monitoring_core.conf
+   ./bin/ppmc ./main.conf
    ```
 
 ## How It Works
@@ -178,7 +178,7 @@ To run the tool periodically, set up a cron job:
 
 ```bash
 # Run every 6 hours
-0 */6 * * * cd /path/to/platform-problem-monitoring-core && ./src/run.sh ./platform_problem_monitoring_core.conf >> /var/log/platform-monitoring.log 2>&1
+0 */6 * * * cd /path/to/platform-problem-monitoring-core && ./src/ppmc ./main.conf >> /var/log/platform-monitoring.log 2>&1
 ```
 
 ## Advanced Configuration

src/platform_problem_monitoring_core/bin/run.sh renamed to bin/ppmc

@@ -1,4 +1,5 @@
-#!/bin/bash
+#!/usr/bin/env bash
+
 # Platform Problem Monitoring Core - Main execution script
 
 set -e  # Exit immediately if a command exits with a non-zero status

docs/NOTES.md

@@ -18,3 +18,8 @@
         }
     }
     '
+
+## TODOs & Ideas
+
+- add step 12 (cleanup) to ppmc
+- add ppmc option to disable cleanup step 12

docs/RELEASE_MANAGEMENT.md

@@ -6,13 +6,8 @@ This document outlines the release process for the Platform Problem Monitoring C
 
 Each release includes the following artifacts:
 
-1. **Python Package Distributions**
-   - **Source Distribution (.tar.gz)** - Contains the raw source code of the package
-   - **Wheel Distribution (.whl)** - A pre-built package that's ready to install
-
-2. **Additional Assets Archive (`additional_assets.zip`)**
-   - `conf/lucene_query.json.dist` - Query template for Elasticsearch
-   - `conf/platform_problem_monitoring_core.conf.dist` - Main configuration file template
+- **Source Distribution (.tar.gz)** - Contains the raw source code of the package
+- **Wheel Distribution (.whl)** - A pre-built package that's ready to install
 
 ## Release Workflow
 

docs/REQUIREMENTS.md

@@ -88,7 +88,7 @@ The tech stack for this application is defined as follows:
 - It is a software application written in Python 3, and provided in source-code form
 - Setup and dependencies are managed via the pyproject.toml approach
 - A bash shell script is provided which allows the user to start the application in a straightforward manner, e.g.
-  ./run.sh <path-to-config-file>
+  ./ppmc <path-to-config-file>
 
 The architecture is defined as follows:
 
@@ -291,7 +291,7 @@ Main operations & side effects, and Outputs:
         - remove the local folder
     - Outputs: none (besides exit code and progress, success, and error messages)
 
-The aforementioned run.sh shell script is able to read a configuration file with the following structure:
+The aforementioned ppmc shell script is able to read a configuration file with the following structure:
 
     REMOTE_STATE_S3_BUCKET_NAME=""
     REMOTE_STATE_S3_FOLDER_NAME=""
@@ -309,12 +309,12 @@ The aforementioned run.sh shell script is able to read a configuration file with
     SMTP_SENDER_ADDRESS=""
     SMTP_RECEIVER_ADDRESS=""
 
-If this configuration is stored in a file called platform_problem_monitoring_core.conf, then the run.sh script can be
-called as `run.sh ./platform_problem_monitoring_core.conf` and will make use of these parameters when executing the
+If this configuration is stored in a file called main.conf, then the ppmc script can be
+called as `ppmc ./main.conf` and will make use of these parameters when executing the
 different step scripts.
 
 Other parameters that are relevant between step script executions, like for example the name of the JSON file where
-downloaded logstash documents are stored, are hardcoded within the run.sh shell script (but paths of intermediate result
+downloaded logstash documents are stored, are hardcoded within the ppmc shell script (but paths of intermediate result
 files are of course located within the temporary work folder created in step 1).
 
 The resulting Python and Bash code must be clean, well documented, with concise and comprehensible naming.

conf/lucene_query.json.dist renamed to etc/lucene_query.json.dist

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "platform_problem_monitoring_core"
-version = "0.1.4"
+version = "0.1.5"
 description = "A tool for monitoring platform problems using Elasticsearch logs"
 authors = [
     {name = "Platform Team"}
@@ -44,11 +44,12 @@ package-dir = {"" = "src"}
 
 # Add package data to include resources in the wheel
 [tool.setuptools.package-data]
-platform_problem_monitoring_core = ["resources/*.html", "bin/*"]
+platform_problem_monitoring_core = ["resources/*.html"]
 
 # Add data files to include configuration templates
 [tool.setuptools.data-files]
-"conf" = ["conf/*.dist"]
+"etc/platform_problem_monitoring_core" = ["etc/*.dist"]
+"bin" = ["bin/*"]
 
 [tool.black]
 line-length = 120