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/Changelog.md b/Changelog.md new file mode 100644 index 0000000..825c32f --- /dev/null +++ b/Changelog.md @@ -0,0 +1 @@ +# Changelog 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, diff --git a/Readme.md b/Readme.md index 2f2c2dc..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 @@ -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 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..1310d22 --- /dev/null +++ b/docs/Readme.md @@ -0,0 +1,7 @@ +# Documentation for the Hugin and Munin framework +## + + + +## + 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