From 96574e0432dedd187147687d2a598a593b6e9cda Mon Sep 17 00:00:00 2001 From: "Madsen, Kent" Date: Fri, 9 Jun 2023 01:59:28 +0200 Subject: [PATCH 1/5] working on documentation Signed-off-by: Madsen, Kent --- Changelog.md | 1 + Readme.md | 5 +++++ 2 files changed, 6 insertions(+) create mode 100644 Changelog.md diff --git a/Changelog.md b/Changelog.md new file mode 100644 index 0000000..825c32f --- /dev/null +++ b/Changelog.md @@ -0,0 +1 @@ +# Changelog diff --git a/Readme.md b/Readme.md index 2f2c2dc..78a4900 100644 --- a/Readme.md +++ b/Readme.md @@ -15,6 +15,11 @@ Framework with the purpose of * temporary configuration memory * temporary working files +## Content +1. [License](License.md) +2. [Changelog](Changelog.md) + + ## Documentation ### Other libraries * [Pytest](https://docs.pytest.org/en/7.3.x/contents.html) \ No newline at end of file From 1686ffe914dade39886b236cbf7180252da8c010 Mon Sep 17 00:00:00 2001 From: "Madsen, Kent" Date: Fri, 9 Jun 2023 02:00:40 +0200 Subject: [PATCH 2/5] removal of space --- License.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/License.md b/License.md index b891fa7..6609671 100644 --- a/License.md +++ b/License.md @@ -7,7 +7,7 @@ including without limitation the rights to use, copy, modify, merge, publish, di 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 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, From 03fb9c6ca3a4672c1db1ce397756ddfd637d206b Mon Sep 17 00:00:00 2001 From: "Madsen, Kent" Date: Fri, 9 Jun 2023 02:03:23 +0200 Subject: [PATCH 3/5] addition of documentation directory Signed-off-by: Madsen, Kent --- Readme.md | 2 +- docs/Changelog.md | 1 + docs/License.md | 17 +++++++++++++++++ docs/Readme.md | 2 ++ 4 files changed, 21 insertions(+), 1 deletion(-) create mode 100644 docs/Changelog.md create mode 100644 docs/License.md create mode 100644 docs/Readme.md diff --git a/Readme.md b/Readme.md index 78a4900..660422b 100644 --- a/Readme.md +++ b/Readme.md @@ -1,4 +1,4 @@ -# The Hugin and Munin Framework +# The Hugin and Munin framework ## Summary ### Installation pip install hm-framework diff --git a/docs/Changelog.md b/docs/Changelog.md new file mode 100644 index 0000000..825c32f --- /dev/null +++ b/docs/Changelog.md @@ -0,0 +1 @@ +# Changelog diff --git a/docs/License.md b/docs/License.md new file mode 100644 index 0000000..6609671 --- /dev/null +++ b/docs/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. diff --git a/docs/Readme.md b/docs/Readme.md new file mode 100644 index 0000000..11c772d --- /dev/null +++ b/docs/Readme.md @@ -0,0 +1,2 @@ +# Documentation the Hugin and Munin framework +## \ No newline at end of file From 5c1cdbc4949d55567a6e36df4f91b7b213710275 Mon Sep 17 00:00:00 2001 From: "Madsen, Kent" Date: Fri, 9 Jun 2023 02:04:04 +0200 Subject: [PATCH 4/5] typo --- docs/Readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Readme.md b/docs/Readme.md index 11c772d..32ca2cd 100644 --- a/docs/Readme.md +++ b/docs/Readme.md @@ -1,2 +1,2 @@ -# Documentation the Hugin and Munin framework +# Documentation for the Hugin and Munin framework ## \ No newline at end of file From 6421dbe08368e378892cbc6a890d37de273d1b0a Mon Sep 17 00:00:00 2001 From: "Madsen, Kent" Date: Mon, 19 Jun 2023 01:26:00 +0200 Subject: [PATCH 5/5] added dependabot Signed-off-by: Madsen, Kent --- .gitattributes | 1 + .github/dependabot.yml | 10 ++++++++++ docs/Readme.md | 7 ++++++- src/HM/main.py | 19 ------------------- src/__init__.py | 0 5 files changed, 17 insertions(+), 20 deletions(-) create mode 100644 .github/dependabot.yml delete mode 100644 src/HM/main.py delete mode 100644 src/__init__.py diff --git a/.gitattributes b/.gitattributes index c69d729..c1ebc96 100644 --- a/.gitattributes +++ b/.gitattributes @@ -5,6 +5,7 @@ *.sh text diff=sh eol=lf *.py text diff=python eol=lf + *.ipynb text eol=lf *.toml text eol=lf diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..fbb3706 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,10 @@ +# To get started with Dependabot version updates, you'll need to specify which +# package ecosystems to update and where the package manifests are located. +# Please see the documentation for all configuration options: +# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates +version: 2 +updates: + - package-ecosystem: "pip" + directory: "/" + schedule: + interval: "daily" \ No newline at end of file diff --git a/docs/Readme.md b/docs/Readme.md index 32ca2cd..1310d22 100644 --- a/docs/Readme.md +++ b/docs/Readme.md @@ -1,2 +1,7 @@ # Documentation for the Hugin and Munin framework -## \ No newline at end of file +## + + + +## + diff --git a/src/HM/main.py b/src/HM/main.py deleted file mode 100644 index 38b0ccd..0000000 --- a/src/HM/main.py +++ /dev/null @@ -1,19 +0,0 @@ -# Used to testing the framework -## TODO: Delete when releasing -from HM.automation.singleton \ - import \ - get_automation_framework, \ - delete_automation_framework - - -def main(): - automation = get_automation_framework() - - automation.setup() - automation.execute() - - delete_automation_framework() - - -if __name__ == '__main__': - main() diff --git a/src/__init__.py b/src/__init__.py deleted file mode 100644 index e69de29..0000000