nob.py 0.1.2

Reasonable defaults for Click CLI applications.

Nob.py

Reasonable defaults for Click CLI applications with rich logging...
... and additional goodies.

1. Installation
2. Usage
3. Contributing
4. TODOs

Installation

uv add nob.py

Or:

pip install nob.py

Install from GitHub

uv add git+https://github.com/ThomasByr/nob.py --branch main

or lock a specific version:

uv add git+https://github.com/ThomasByr/nob.py --tag v0.1.0

Or if you are using pip

pip install git+https://github.com/ThomasByr/nob.py@main

You may directly also use @ with a tag, for example:

pip install git+https://github.com/ThomasByr/nob.py@v0.1.0

Usage

[!Note] Get more usage examples in the Wiki.

import logging

from nob import cli


@cli.cmd()
@cli.opt("--name", required=True, help="Greet someone.")
def hello(lg: logging.Logger, name: str):
    lg.info("Hello %s", name)


if __name__ == "__main__":
    hello()

run with:

uv run <file.py> --name "Eric Norbert"

Replace uv run with python once your environment is activated - if you don't use uv.

Contributing

[!Important] Sign your commits.

Clone the repository if you have direct right access or clone your fork:

git clone [e-mail]:ThomasByr/nob.py nob

Then:

1. Install uv if you haven't already (or run uv self update):

   Linux Bash

   curl -LsSf https://astral.sh/uv/install.sh | sh
   

   Windows Powershell

   powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
   

2. Install just:

   cargo install --locked just just-lsp
   

   List all available recipes by typing just.

3. Sync the codebase dependencies

   Without explicit --all-extras syncing, some recipes will not evaluate on optional dependencies and functionalities.

   just sync
   

Run the following recipes before committing.

We (I) work with ruff, ty and pytest.

just format check ty test

[!TIP] Install pre-commit hooks: just pc-install.
To keep hooks somewhat fast enough, they will only check (not forcibly fix) for typing and formatting.

TODOs

• workflow to publish to PyPI
• update the progress module to use human count and duration