From dab6154f33b1f2cd4f84f08c324165acb1127934 Mon Sep 17 00:00:00 2001 From: Mathew Guest Date: Fri, 15 Nov 2024 19:44:11 -0700 Subject: [PATCH] feat: switched license to MIT no attribution --- LICENSE.txt | 35 +++++++++++++++-------------------- README.md | 53 +++++++++++++++++++++++++++-------------------------- 2 files changed, 42 insertions(+), 46 deletions(-) diff --git a/LICENSE.txt b/LICENSE.txt index a454efe..bb2ff5b 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,25 +1,20 @@ App Skellington +MIT No Attribution + Copyright (c) 2024 Mathew Guest -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. +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. +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/README.md b/README.md index 731f5b6..c39f85b 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ app_skellington =============== + Application framework for Python, features include: - Pain-free multi-level command menu: Expose public class methods as commands available to user. - Simple to define services and automatic dependency injection based on name (with custom invocation as an option). \*WIP @@ -13,13 +14,12 @@ Principles: - Compatable with Linux, Windows, and Mac. Try to be compatible as possible otherwise. - Try to be compatible with alternate Python runtimes such as PyPy and older python environments. \*WIP -PyPi Hosted Link ----------------- +# PyPi Hosted Link https://pypi.org/project/app-skellington/ -Application Configuration -------------------------- +# Application Configuration + Site configurations are supported through ConfigObj. There is a config.spec in the src directory which is a validation file; it contains the accepted parameter names, types, and limits for configurable options in the @@ -37,21 +37,19 @@ parameters are added into the config file. Linux: -/home/\/.config/\/config.ini - -/home/\/.cache/\/log/\.log + * /home/\/.config/\/config.ini + * /home/\/.cache/\/log/\.log Windows: -C:\\Users\\\\\\\\Local\\\\\config.ini - -C:\\Users\\\\\\\\Local\\\\\Logs\\\.log + * C:\\Users\\\\\\\\Local\\\\\config.ini + * C:\\Users\\\\\\\\Local\\\\\Logs\\\.log Application configuration can be overridden ad-hoc through the --config argument. -Debug - Turn on Logging ------------------------ +# Debug - Turn on Logging + Set 'APPSKELLINGTON_ENABLE_LOGGING' environment variable to any value which turns on AppSkellington-level logging. For example, @@ -62,12 +60,12 @@ or export APPSKELLINGTON_DEBUG=1 -Tests ------ +# Tests + Tests are a WIP. Recommendation is to run 'pytest' in the 'tests' directory. -Development ------------ +# Development + Clone the repo: ```commandline git clone https://git-mirror.zavage.net/zavage-software/app_skellington.git @@ -88,14 +86,17 @@ pre-commit install Begin development. -License -------- -I'm releasing this software under one of the most permissive -licenses, the MIT software license. This applies to this source repository -and all files within it. Alternatively, you are permitted you -to use any of this under the GPL to the fullest legal extent allowed. +# License + +MIT no attribution required - https://opensource.org/license/mit-0 + + * Allows commercial use. + * Allows modifications and closed-source derivatives. + * Fully interoperable with nearly all other open-source licenses, including GPL (when combined properly). + +# See Also + + * Project page: https://zavage-software.com/portfolio/app_skellington + * Please report bugs, improvements, or feedback! + * Contact: mathew@zavage.net -Notes ------ -See official website: https://zavage-software.com -Please report bugs, improvements, or feedback!