splatlog 0.4.1

Python logger that accepts ** values and prints 'em out.

splatlog

Python logger that accepts ** values and prints 'em out.

Because I'll forget, and because I know I'll look here when I do...

Usage

# Swap `splatlog` for `logging`
import splatlog

# Get a logger instance same as you would from `logging`
log = splatlog.getLogger(__name__)

# In your `__main__.py` or wherever you get started
splatlog.setup(level="info", console="stderr")

Development

Setup the nix package manager on your machine and run:

nix-shell

That's it, you should be in a shell session with uv, python, dr.t, make, sphinx-build, and everything else you'll need available.

What nix-shell did:

1. Install uv and enter a shell session with it (and other system dependencies) available
2. Run uv sync to
   1. Install a compatible Python version
   2. Create a new Python Virtual Environment (venv)
   3. Install package dependencies specified in pyproject.toml from PyPi into the venv
3. Run source .venv/bin/activate to activate the venv, making the Python packages and executables available

These steps are specified in the shell.nix file.

⁉️ If you do not want to use nix for whatever reason, you should be fine getting uv from your OS package manager or the online installer. Just run uv sync and source .venv/bin/activate and you should be good.

⁉️ If you do not want to use uv for whatever reason, you should — in theory — be able to substitute your favorite Python ecosystem tool that understands the pyproject.toml standard.

Building Docs

cd ./docs && make html

Watching and serving:

cd ./docs && make watch

Running Tests

All of them:

tox

Single file:

poe test <filename>

Publishing

1. Update the version in pyproject.toml.

2. Commit, tag vX.Y.Z, push.

3. Log in to PyPI and go to

   https://pypi.org/manage/account/

   to generate an API token.

4. Use uv to build and publish:

   uv build
   uv publish --token <token>
   

5. Bump patch by 1 and append a0, commit and push (now we're on the "alpha" of the next patch version).