Metadata-Version: 2.1
Name: fancylog
Version: 0.4.2
Summary: Fancier logging in Python
Author-email: Adam Tyson <code@adamltyson.com>
License: BSD-3-Clause
Project-URL: homepage, https://github.com/neuroinformatics-unit/fancylog
Project-URL: bug_tracker, https://github.com/neuroinformatics-unit/fancylog/issues
Project-URL: documentation, https://github.com/neuroinformatics-unit/fancylog
Project-URL: source_code, https://github.com/neuroinformatics-unit/fancylog
Project-URL: user_support, https://github.com/neuroinformatics-unit/fancylog/issues
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: BSD License
Requires-Python: >=3.9.0
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: rich
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: coverage; extra == "dev"
Requires-Dist: tox; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: setuptools_scm; extra == "dev"
Provides-Extra: git
Requires-Dist: gitpython; extra == "git"

[![Python Version](https://img.shields.io/pypi/pyversions/cellfinder.svg)](https://pypi.org/project/cellfinder)
[![PyPI](https://img.shields.io/pypi/v/fancylog.svg)](https://pypi.org/project/fancylog)
[![Downloads](https://pepy.tech/badge/fancylog)](https://pepy.tech/project/fancylog)
[![Wheel](https://img.shields.io/pypi/wheel/fancylog.svg)](https://pypi.org/project/fancylog)
[![Development Status](https://img.shields.io/pypi/status/fancylog.svg)](https://github.com/neuroinformatics-unit/fancylog)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black)
[![Contributions](https://img.shields.io/badge/Contributions-Welcome-brightgreen.svg)](https://github.com/neuroinformatics-unit/fancylog)

# fancylog
Fancier logging with python.

Uses the standard python logging library, but (optionally) in addition:
* Logs code when using the multiprocessing module using
[multiprocessing-logging](https://github.com/jruere/multiprocessing-logging)
* Uses [GitPython](https://github.com/gitpython-developers/GitPython)
to log information about the git environment.
* Logs the command-line arguments used to run the software
* Logs object attributes


#### To install
```bash
pip install fancylog
```

N.B. For the git logging to work, you need to have [git](https://git-scm.com/) and the
[GitPython](https://github.com/gitpython-developers/GitPython) package
installed. The latter can be installed along with `fancylog` using:

```bash
pip install fancylog[git]
```

#### To run example
```bash
git clone https://github.com/neuroinformatics-unit/fancylog
pip install -e .
python fancylog/example.py /path/to/output/log/dir
```

If you run the example, you should get a log file that resembles
[this](fancylog_2019-10-18_15-30-12.log)
