zavage-software/app_skellington
1
0
Fork 0
mirror of https://git.zavage.net/Zavage-Software/app_skellington.git synced 2024-12-21 22:29:20 -07:00
Code Issues Actions Packages Projects Releases Wiki Activity

feat: switched license to MIT no attribution

Browse Source
This commit is contained in:
Mathew Guest 2024-11-15 19:44:11 -07:00
parent 5c6a486913
commit dab6154f33
2 changed files with 42 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
LICENSE.txt
View File

@ -1,25 +1,20 @@
App Skellington App Skellington
MIT No Attribution
Copyright (c) 2024 Mathew Guest Copyright (c) 2024 Mathew Guest
Permission is hereby granted, free of charge, to any person Permission is hereby granted, free of charge, to any person obtaining a
obtaining a copy of this software and associated documentation copy of this software and associated documentation files (the
files (the "Software"), to deal in the Software without "Software"), to deal in the Software without restriction, including
restriction, including without limitation the rights to use, without limitation the rights to use, copy, modify, merge, publish,
copy, modify, merge, publish, distribute, sublicense, and/or sell distribute, sublicense, and/or sell copies of the Software, and to permit
copies of the Software, and to permit persons to whom the persons to whom the Software is furnished to do so.
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.
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.

53
README.md
View File

@ -1,5 +1,6 @@
app_skellington app_skellington
=============== ===============
Application framework for Python, features include: Application framework for Python, features include:
- Pain-free multi-level command menu: Expose public class methods as commands available to user. - 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 - 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. - 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 - 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/ https://pypi.org/project/app-skellington/
Application Configuration # Application Configuration
-------------------------
Site configurations are supported through ConfigObj. There is a config.spec Site configurations are supported through ConfigObj. There is a config.spec
in the src directory which is a validation file; it contains the accepted in the src directory which is a validation file; it contains the accepted
parameter names, types, and limits for configurable options in the parameter names, types, and limits for configurable options in the
@ -37,21 +37,19 @@ parameters are added into the config file.
Linux: Linux:
/home/\<user\>/.config/\<app_name\>/config.ini * /home/\<user\>/.config/\<app_name\>/config.ini
* /home/\<user\>/.cache/\<app_name\>/log/\<app_name\>.log
/home/\<user\>/.cache/\<app_name\>/log/\<app_name\>.log
Windows: Windows:
C:\\Users\\\<user>\\\<app_name\>\\Local\\\<app_name\>\\config.ini * C:\\Users\\\<user>\\\<app_name\>\\Local\\\<app_name\>\\config.ini
* C:\\Users\\\<user>\\\<app_name\>\\Local\\\<app_name\>\\Logs\\\<app_name\>.log
C:\\Users\\\<user>\\\<app_name\>\\Local\\\<app_name\>\\Logs\\\<app_name\>.log
Application configuration can be overridden ad-hoc through the --config <filename> Application configuration can be overridden ad-hoc through the --config <filename>
argument. argument.
Debug - Turn on Logging # Debug - Turn on Logging
-----------------------
Set 'APPSKELLINGTON_ENABLE_LOGGING' environment variable to any value which turns Set 'APPSKELLINGTON_ENABLE_LOGGING' environment variable to any value which turns
on AppSkellington-level logging. For example, on AppSkellington-level logging. For example,
@ -62,12 +60,12 @@ or
export APPSKELLINGTON_DEBUG=1 export APPSKELLINGTON_DEBUG=1
<executable> <executable>
Tests # Tests
-----
Tests are a WIP. Recommendation is to run 'pytest' in the 'tests' directory. Tests are a WIP. Recommendation is to run 'pytest' in the 'tests' directory.
Development # Development
-----------
Clone the repo: Clone the repo:
```commandline ```commandline
git clone https://git-mirror.zavage.net/zavage-software/app_skellington.git git clone https://git-mirror.zavage.net/zavage-software/app_skellington.git
@ -88,14 +86,17 @@ pre-commit install
Begin development. Begin development.
License # License
-------
I'm releasing this software under one of the most permissive MIT no attribution required - https://opensource.org/license/mit-0
licenses, the MIT software license. This applies to this source repository
and all files within it. Alternatively, you are permitted you * Allows commercial use.
to use any of this under the GPL to the fullest legal extent allowed. * 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!