Initial commit.

Author: franckferman

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,58 @@
+---
+name: Bug report
+about: Your detailed bug reports are pivotal in elevating this project's quality.
+  Your expertise in identifying issues is deeply valued and appreciated.
+title: "[ISSUE] Problem Encountered"
+labels: bug
+assignees: franckferman
+
+---
+
+## Problem Summary
+_Provide a clear and concise summary of the encountered issue._
+
+## Steps to Reproduce
+Provide a step-by-step description on how to reproduce the anomaly:
+
+1. Command initiated: `...`
+2. During the process: `....`
+3. Observed issue: `....`
+4. Output/response anomaly: `...`
+
+## Expected Outcome
+_Describe the anticipated result after executing the provided steps._
+
+## Visual Evidence
+If possible, attach screenshots to support your description.
+
+## Technical Details
+
+### Operating System
+
+- **Linux:** [e.g. Linux root 4.19.0-6-amd64 #1 SMP Debian 4.19.67-2+deb10u1 (2019-09-20) x86_64 GNU/Linux]
+  *Retrieval:* `uname -a`
+
+- **Windows:** [e.g. Microsoft Windows 10 Pro DevBox 10.0.15063 Multiprocessor Free 64-bit]
+  *Retrieval:* 
+  ```powershell
+  $Properties = 'Caption', 'CSName', 'Version', 'BuildType', 'OSArchitecture'
+  Get-CimInstance Win32_OperatingSystem | Select-Object $Properties | Format-Table -AutoSize
+  ```
+
+### Software Versions
+
+- **Python**: [e.g. Python 3.11.4]
+  *Retrieval:* `python3 -V`
+
+- **Exiftool**: [e.g. 12.56]
+  *Retrieval:* `exiftool -ver`
+
+- **MetaDetective**: [e.g. 1.0.8]
+
+### Docker (if used)
+
+- **Image Version**: [e.g. "1.0.1"]
+
+## Additional Information
+
+Provide any other pertinent details or context regarding the issue.

.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,28 @@
+---
+name: Feature request
+about: Clearly outline the primary goal of this feature request.
+title: "[FEATURE]"
+labels: enhancement
+assignees: franckferman
+
+---
+
+**Problem Nexus:**
+_Can you link this feature request to an existing problem or limitation?_
+Provide a precise and thorough depiction of the issue. For instance, "The current workflow requires manual data entry, leading to inefficiencies and potential for error."
+
+**Envisioned Solution:**
+_Detail the desired feature or enhancement._
+Expound upon how you imagine this feature will function, how it will address the problem, and the advantages it will introduce.
+
+**Alternative Strategies Assessed:**
+_Have you thought of other potential solutions?_
+List and briefly explain other solutions or functionalities you've considered. Highlight why they might be less optimal than your proposed solution.
+
+**Implications and Integration:**
+_How will this feature fit into the current system?_
+Discuss any potential interactions with existing features, how it aligns with the project's goals, or any other relevant integrations.
+
+**Visual Demonstrations (if applicable):**
+_Do you have visual aids or mock-ups?_
+Embed any diagrams, wireframes, or screenshots that can provide clarity on the desired feature's function and integration.

.github/workflows/bandit.yml

@@ -0,0 +1,31 @@
+name: bandit
+
+on:
+  push:
+    branches: [ "stable" ]
+    paths:
+      - 'src/MetaDetective/MetaDetective.py'
+  pull_request:
+    branches: [ "stable" ]
+    paths:
+      - 'src/MetaDetective/MetaDetective.py'
+
+jobs:
+  security-check:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout Repository
+      uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.11
+
+    - name: Install Bandit
+      run: pip install bandit
+
+    - name: Run Bandit
+      run: bandit ./src/MetaDetective/MetaDetective.py -s B404,B607,B603,B310
+

.github/workflows/docker-image.yml

@@ -0,0 +1,28 @@
+name: docker-image
+
+on:
+  push:
+    branches: [ "stable" ]
+    paths:
+      - 'docker/Dockerfile'
+  pull_request:
+    branches: [ "stable" ]
+    paths:
+      - 'docker/Dockerfile'
+
+jobs:
+
+  build_and_push:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    
+    - name: Build the Docker image
+      run: docker build . --file docker/Dockerfile --tag franckferman/metadetective:1.0.9-df.2
+      
+    - name: Login to Docker Hub
+      run: docker login -u ${{ secrets.DOCKER_USERNAME }} -p ${{ secrets.DOCKER_PASSWORD }}
+    - name: Push Docker Image
+      run: docker push franckferman/metadetective:1.0.9-df.2

.github/workflows/pep8.yml

@@ -0,0 +1,33 @@
+name: pep8
+
+on:
+  push:
+    branches: [ "stable" ]
+    paths:
+      - 'tests/test_MetaDetective.py'
+      - 'src/MetaDetective/MetaDetective.py'
+  pull_request:
+    branches: [ "stable" ]
+    paths:
+      - 'tests/test_MetaDetective.py'
+      - 'src/MetaDetective/MetaDetective.py'
+
+jobs:
+  flake8:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout Repository
+      uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.11
+
+    - name: Install flake8
+      run: pip install flake8
+
+    - name: Check PEP8 compliance
+      run: flake8 . --count --ignore=E501
+

.github/workflows/python-publish.yml

@@ -0,0 +1,32 @@
+name: python-publish
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}
+

.github/workflows/static.yml

@@ -0,0 +1,47 @@
+name: static
+
+on:
+  push:
+    branches: [ "stable" ]
+    paths:
+      - 'docs/website/**'
+  pull_request:
+    branches: [ "stable" ]
+    paths:
+      - 'docs/website/**'
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          # Upload entire repository
+          path: './docs/website'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.github/workflows/unittest.yml

@@ -0,0 +1,29 @@
+name: unittest
+
+on:
+  push:
+    branches: [ "stable" ]
+    paths:
+      - 'tests/test_MetaDetective.py'
+      - 'src/MetaDetective/MetaDetective.py'
+  pull_request:
+    branches: [ "stable" ]
+    paths:
+      - 'tests/test_MetaDetective.py'
+      - 'src/MetaDetective/MetaDetective.py'
+
+jobs:
+  unittest:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout Repository
+      uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.11
+
+    - name: Run Unit Tests
+      run: python -m unittest discover tests -p '*test*.py'