Merge pull request #10 from KentVejrupMadsen/development

sync. & addition of documentation

.gitattributes

@@ -1,7 +1,8 @@
 # Default for all
 * text=auto
 
-*.md text diff=markdown eol=crlf
+*.md text diff=markdown eol=lf
+
 *.sh text diff=sh eol=lf
 *.py text diff=python eol=lf
 *.ipynb text eol=lf
@@ -13,4 +14,4 @@
 .gitattributes text eol=lf
 
 /.github export-ignore
-CHANGELOG.md export-ignore
+

.github/workflows/python-package.yml

@@ -0,0 +1,30 @@
+name: Python package
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main", "development" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.8", "3.9", "3.10"]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Test with pytest
+      run: |
+        pytest

.gitignore

@@ -5,6 +5,8 @@ venv/*
 # IDE Directories to ignore
 .idea/*
 dist/*
+.pytest_cache/*
+__*__/*
 
 # directories to be ignored
 hm_framework.egg-info/*

License.md

@@ -0,0 +1,17 @@
+# MIT License
+Copyright 2023 Kent vejrup Madsen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software 
+and associated documentation files (the “Software”), to deal in the Software without restriction, 
+including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, 
+and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, 
+subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, 
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, 
+DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Readme.md

@@ -1,8 +1,9 @@
-# Project - The Hugin and Munin Framework
-## Installation
+# The Hugin and Munin Framework
+## Summary
+### Installation
     pip install hm-framework
 
-## Description
+### Description
 Framework with the purpose of 
 * to extract information from media files
 
@@ -13,3 +14,7 @@ Framework with the purpose of
     * Output 
   * temporary configuration memory
   * temporary working files
+
+## Documentation
+### Other libraries
+* [Pytest](https://docs.pytest.org/en/7.3.x/contents.html)

requirements.txt

@@ -1 +1,2 @@
 pillow
+pytest