From: Roni Riska Date: Wed, 6 Nov 2019 13:37:27 +0000 (+0200) Subject: Move python sources to a subdir X-Git-Tag: 1.1.2~12 X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=fd81654062dda10ab9ee1867a29fd5024be3bcd9;p=com%2Fpylog.git Move python sources to a subdir To better support CI process, all python code including tox.ini and setup.py are moved to mdclogpy subdir. Now changes to release dir and mdclogpy dir will trigger different ci jobs. Change-Id: I15d2414a68dcca51d01a4187050b4140ff872abf Signed-off-by: Roni Riska --- diff --git a/README.md b/README.md index 10009c3..5ae51a7 100644 --- a/README.md +++ b/README.md @@ -1,109 +1,3 @@ -Mdclogpy -======== +# Python logging library with mdc support -Structured logging library with Mapped Diagnostic Context - -* Outputs the log entries to standard out in structured format, json currently. -* Severity based filtering. -* Supports Mapped Diagnostic Context (MDC). - Set MDC pairs are automatically added to log entries by the library. - - -Log entry format ----------------- - -Each log entry written with mdclog_write() function contains - -* Timestamp -* Logger identity -* Log entry severity -* All existing MDC pairs -* Log message text - -Currently the library only supports JSON formatted output written to standard -out of the process. - -*Example log output* - -`{"ts": 1559285893047, "crit": "INFO", "id": "myprog", "mdc": {"second key":"other value","mykey":"keyval"}, "msg": "Hello world!"}` - -Install -------- - -Install from PyPi - -``` -python3 -m pip install mdclogpy -``` - -Install using the source - -``` -python3 setup.py install -``` - -Usage ------ - -The library can be used in two ways shown below. - -1) Use the root logger - -```python - import mdclogpy - mdclogpy.error("This is an error log") -``` - -2) Create a logger instance - -```python - from mdclogpy import Logger - my_logger = Logger() - my_logger.error("This is an error log") -``` - -A program can create several logger instances. - - -Mapped Diagnostics Context --------------------------- - -The MDCs are logger instance specific key-value pairs, which are included to -all log entries written via the logger instance. - -By default, the library implements a root logger instance. -MDCs added to the root logger instance are added only to the log entries -written via the root logger instance. - - -License -------- - -Copyright (c) 2019 AT&T Intellectual Property. -Copyright (c) 2018-2019 Nokia. - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. - - -Unit testing ------------- - -To run the unit tests run the following command in the package directory:: -` -python3 -m unittest discover -` - -CI --- - -The ci is done with the `tox` tool. See `tox.ini` file for details. +Please see the [README.md](./mdclogpy/README.md) in `mdclogpy` directory. diff --git a/mdclogpy/README.md b/mdclogpy/README.md new file mode 100644 index 0000000..10009c3 --- /dev/null +++ b/mdclogpy/README.md @@ -0,0 +1,109 @@ +Mdclogpy +======== + +Structured logging library with Mapped Diagnostic Context + +* Outputs the log entries to standard out in structured format, json currently. +* Severity based filtering. +* Supports Mapped Diagnostic Context (MDC). + Set MDC pairs are automatically added to log entries by the library. + + +Log entry format +---------------- + +Each log entry written with mdclog_write() function contains + +* Timestamp +* Logger identity +* Log entry severity +* All existing MDC pairs +* Log message text + +Currently the library only supports JSON formatted output written to standard +out of the process. + +*Example log output* + +`{"ts": 1559285893047, "crit": "INFO", "id": "myprog", "mdc": {"second key":"other value","mykey":"keyval"}, "msg": "Hello world!"}` + +Install +------- + +Install from PyPi + +``` +python3 -m pip install mdclogpy +``` + +Install using the source + +``` +python3 setup.py install +``` + +Usage +----- + +The library can be used in two ways shown below. + +1) Use the root logger + +```python + import mdclogpy + mdclogpy.error("This is an error log") +``` + +2) Create a logger instance + +```python + from mdclogpy import Logger + my_logger = Logger() + my_logger.error("This is an error log") +``` + +A program can create several logger instances. + + +Mapped Diagnostics Context +-------------------------- + +The MDCs are logger instance specific key-value pairs, which are included to +all log entries written via the logger instance. + +By default, the library implements a root logger instance. +MDCs added to the root logger instance are added only to the log entries +written via the root logger instance. + + +License +------- + +Copyright (c) 2019 AT&T Intellectual Property. +Copyright (c) 2018-2019 Nokia. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + + +Unit testing +------------ + +To run the unit tests run the following command in the package directory:: +` +python3 -m unittest discover +` + +CI +-- + +The ci is done with the `tox` tool. See `tox.ini` file for details. diff --git a/mdclogpy/Logger.py b/mdclogpy/mdclogpy/Logger.py similarity index 100% rename from mdclogpy/Logger.py rename to mdclogpy/mdclogpy/Logger.py diff --git a/mdclogpy/__init__.py b/mdclogpy/mdclogpy/__init__.py similarity index 100% rename from mdclogpy/__init__.py rename to mdclogpy/mdclogpy/__init__.py diff --git a/setup.py b/mdclogpy/setup.py similarity index 98% rename from setup.py rename to mdclogpy/setup.py index 80ded84..f3430a7 100644 --- a/setup.py +++ b/mdclogpy/setup.py @@ -34,6 +34,7 @@ setup(name='mdclogpy', ], url='https://gerrit.o-ran-sc.org/r/admin/repos/com/pylog', author_email='kturunen@nokia.com', + author='kturunen', license='Apache Software License', packages=['mdclogpy'], zip_safe=False) diff --git a/tox.ini b/mdclogpy/tox.ini similarity index 100% rename from tox.ini rename to mdclogpy/tox.ini