gyomu 0.1.5a2

Enterprise operational framework

*This package is originally developed in C#, and now try to migrate into Python version

Gyomu

Gyomu, which means Enterprise or Operation in Japanese, is used in enterprise. The purpose of this library is

1. Shorten development time through framework
2. Shorten troubleshooting in testing or in production

This library won't be used by library itself. It's used with RDB ( Now Postgres & MSSQL is supported )

This library contains lots of function, but major functionality would be

• Error handling / Logging
• Various Parameter management
• Task management
• Milestone management
• Others

Error handling / Logging

All status/ log to be stored in database Based on setting, status/log to be sent via email. Like log4net, etc, there are several logging type, such as Info / Warning / Business Notification / IT Error. For IT error, the status/log contains stack trace so that developer could resolve issue very quickly. The error is sent via email promptly so it doesn't take time to search inside log file.

When you use this framework, at least all public method should return StatusCode object. StatusCode object contains error/log information and when it's instantiated, it would be recorded in DB and be sent via email if necessary.

StatusCode's id is Int (32bit) 1st 12bit is ApplicationID which must be unique per your library 2nd 4bit is logging type, such as Info / Warning / Business Notification / IT Error. Remaining 16bit is Error ID which must be unique within your library. Combining these number lead to uniqueness among all libraries.

</code></pre>
<p>This is example of how to set StatusCode's id.
Regarding CODE_GEN function's argument</p>
<ul>
<li>ApplicationID</li>
<li>logging type</li>
<li>Error ID</li>
<li>Summary</li>
<li>Detail</li>
</ul>
<p>Your assigned ApplicationID must be registered in DB table, apps_info_cdtbl. apps_info_cdtbl column would be ApplicationID.
1-4095 can be assigned and 1 is already used in Gyomu library.
I would recommend you to set some rule by yourselves, such as common library would be <= 99, business logic library would be >=100 <500, Server side like web library would be >=500 <2000, GUI would be >=2000 or something like that.</p>
<p>Email recipient information need to be setup per ApplicationID on status_handler table. You can set To / CC address on this table.</p>
<h1><a href="#user-content-various-parameter-management" aria-hidden="true" class="anchor" id="user-content-various-parameter-management"></a>Various Parameter management</h1>
<p>In most programs, we tend to put external parameter on</p>
<ul>
<li>Configuration file</li>
<li>Environment Variables</li>
</ul>
<p>And I believe this is very difficult to manage for proper environment.
Sometimes, parameter must be different per user, must be different per machine, etc.</p>
<p>In this framework, parameter would be saved in database.
Using Json serialization, mostly any kind of data to be parameterized easily.</p>
<p>Also this parameterization supports several kind of encoding/encryption</p>
<ul>
<li>Base64 Encoding</li>
<li>AES Encryption</li>
<li>User specific encryption ( This is not supported in Python version so far)</li>
</ul>
<p>Base64 encoding can be used for easy masking.
It's easy to be decoded, but at a glance, we can't see raw value.</p>
<p>AES Encryption can be used for storing DB connection string, etc</p>
<p>User specific encryption can be used for personal password.
The encrypted value can be decrypted only by encrypted user.</p>
<p>This example stores/retrieves string list parameter</p>
<pre><code class="language-Python">