Skip to content

Latest commit

 

History

History
94 lines (70 loc) · 5.5 KB

README.md

File metadata and controls

94 lines (70 loc) · 5.5 KB

logutils

Better logging made easy with support for structlog and the standard logging module.

Badges 📛

project status badges:

CI Workflow Coverage Documentation Status Package Health

version badges:

Project Version Python Versions Cookiecutter: cc-python Docker: bbugyi/python

tools / frameworks used by test suite (i.e. used by make test):

Framework: pytest Framework: doctest Runner: tox Types: typeguard Mocks: pytest-mock Snapshots: syrupy

linters used to maintain code quality (i.e. used by make lint):

Linter: pylint Linter: flake8 Types: mypy Docstrings: pydocstyle Code Style: black Imports: isort

tools / frameworks used to render documentation (i.e used by make build-docs):

Rendered By: sphinx Hosted On: ReadTheDocs Types: sphinx-autodoc-typehints Markdown: m2r2

miscellaneous tools used to maintain this project:

Cookiecutter Updates: cruft Requirements: pip-tools Releases: bump2version Versioning: setuptools_scm

Installation 🗹

To install pylogutils using pip, run the following commands in your terminal:

python3 -m pip install --user pylogutils  # install logutils

If you don't have pip installed, this Python installation guide can guide you through the process.

Useful Links 🔗

  • API Reference: A developer's reference of the API exposed by this project.
  • cc-python: The cookiecutter that was used to generate this project. Changes made to this cookiecutter are periodically synced with this project using cruft.
  • CHANGELOG.md: We use this file to document all notable changes made to this project.
  • CONTRIBUTING.md: This document contains guidelines for developers interested in contributing to this project.
  • Create a New Issue: Create a new GitHub issue for this project.
  • Documentation: This project's full documentation.