pymbs.log module

PyMBS is a Python library for use in modeling Mortgage-Backed Securities.

Copyright (C) 2019 Brian Farrell

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.

Contact: brian.farrell@me.com

The log module reads-in the pymbs_logging.json file that comes with the distribution and sets up logging for PyMBS. This default file should suffice for most installations, but the user is able to cutomize logging through the use of environment variables.

If you would like to specify your own logging config file, in JSON format, you can specify the location of that custom config file with the PYMBS_LOG_CONFIG environment variable.

By default, the log level is set to INFO. If you would like to change the level, you may set it using the PYMBS_LOG_LEVEL environment variable.

By default, the log file itself is located in platform-specific locations, as shown below:

Platform

Log File Path

Mac OSX

~/.local/log/pymbs/pymbs.log

Linux

~/.local/log/pymbs/pymbs.log

Windows

C:\Users\<user>\AppData\Local\pymbs\pymbs.log

If you would like to specify your own log file location, you can specify the location with the PYMBS_LOG_FILE environment variable.

pymbs.log.get_logger(logger_name)[source]

Return a logger instance named logger_name