Commit Graph

13 Commits

Author SHA1 Message Date
9ea22d95ea
Updated .gitignore 2022-05-04 00:14:53 +01:00
8eccf1907d
Added tox.ini
File to perform integration testing on different version of Python that ensure Python runs on all defined versions
2022-05-03 23:40:19 +01:00
8302e750df
Added README.md
TODO: complete README.md
2022-05-03 23:36:13 +01:00
cd2e477430
Added packaging build files
The committed files define the requirements and information related to
clog when packaging the module into a library.

setup.py instantiates the build script process used by pip in editor
mode, with the support of setup.cfg. File uses traditional build
approach using the setuptools library.
2022-05-03 23:32:53 +01:00
5da9e7990e
Moved package modules into clog
All files related to the clog package have been moved into the directory
space "clog/" to separate project repository from package itself, and
allows for the building of the package tool via pip.

Added a __version__.py file to contain all important attributes about
the package.
2022-05-03 23:28:44 +01:00
19fb760fa9
Updated .gitignore 2022-05-03 23:20:28 +01:00
d1b06d3d44
Udpated utils/common.py
Added docstrings to module functions and classes, explaining purpose and
function of the function/class. Outline the parameters and return types.

`is_path_spec` renamed to use snake_case. Constants also made globally
to the module.
2022-05-03 18:18:52 +01:00
ea99138469
Updated utils/printfmt.py
Module given docstrings to explain the purpose and function of defined
module functions. Giving parameter and return values of functions.

Module now contains `gen_log_header` moved from the `Logger` class,
along with global constants for the function.
2022-05-03 18:16:54 +01:00
6ddb43d194
Updated _logger.py
Module given docstrings to extensively explain the purpose and function
of defined methods within the class, and class structure itself.

Method `genLogHeader` has been moved to `printfmt` module and renamed
`gen_log_header`, along with appropriate private attributes now global
constants in the module.
2022-05-03 18:13:18 +01:00
a0e487a2a7
Updated main.py
Added another example of how to log with pseudologs
2022-05-03 18:12:59 +01:00
5e922c5515
Added clog package modules
This commit is a continuation from commit [3746b773f4] which is a
separation of library modules into its own package from a larger
project.

Version control jump is significant in feature implementations due
simply to under-using commit control after minor feature
implementations. Project will receive better commit messages going
forward on changes to the package.
2022-05-03 14:51:57 +01:00
b91572874e
Added LICENCE.txt
Added the GNU GPLv3+ licence agreement
2022-05-03 14:51:54 +01:00
d4eb1820a7
Added .gitignore
Ignore unnecessary files and folders
2022-05-03 14:48:10 +01:00