LifeOmic Python Logging

Project Status

Getting Started

Dependencies

• Python 3 version >= 3.6 and <= 3.9.25 (contributions welcome to bring this up to 3.13+)

Getting the Source

This project is hosted on GitHub. You can clone this project directly using this command:

git clone [email protected]:lifeomic/logging-py.git

Development

Python environments are managed using virtualenv. Be sure to have this installed first pip install virtualenv. The makefile will setup the environment for the targets listed below.

Running tests

make test

Linting

make lint

Installation

pip3 install lifeomic_logging

Usage

from lifeomic_logging import scoped_logger

with scoped_logger(__name__, { "bar": "foo" }) as log:
  log.info("message")

Release Process

Releases are generally created with each merged PR. Packages for each release are published to PyPi. See CHANGELOG.md for release notes.

To release a new version of the package, update the version number in lifeomic_logging/version.py as a part of your change, and the new version will be released automatically to PyPi on merge.

Versioning

This project uses Semantic Versioning.

Contributing

We encourage public contributions! Please review CONTRIBUTING.md and CODE_OF_CONDUCT.md for details on our code of conduct and development process.

License

This project is licensed under the MIT License - see LICENSE file for details.

Authors

See the list of contributors who participate in this project.