How to run a library module?

[ollimandoliini]

What is the recommended way for running a library module like I would do in vanilla python with the -m flag.

E.g.

python -m mylibrary.module

[gusutabopb]

I believe that'd be simply

uv run python -m mylibrary.module

[ollimandoliini]

Thanks! That's what I have been using.

It's a bit confusing because there is no parallel for uv run file.py for running a module.

[charliermarsh]

We could consider adding -m module but in the meantime yes, explicitly adding python there is expected (\cc @zanieb).

[zanieb]

I think we should document this. I'm not sure we should provide a shorthand yet... but it does seem kind of nice?

[johnhoran]

One downside to the uv run python -m mylibrary.module approach is that this doesn't allow for the inline script metadata.

[zanieb]

In that case, your module is defined in a script?

[johnhoran]

Some are in scripts, others are in folders with a __main__.py file.

[rogerbinns]

My package has several command line tools that are invoked via -m. They are not installed as separate commands. For example you can do the following which all take extra parameters.

# gets a database cli shell
python -m apsw
# runs test suite
python -m apsw.tests
# runs benchmark
python -m apsw.speedtest
# runs automatic tracer of SQL
python -m apsw.trace

I have 3 more under development. I was hoping that I could do uvx run apsw, uvx run apsw.speedtest etc perhaps with a -m flag. Sadly that is not the case. Doing uv run python -m apsw.speedtest doesn't automagically install the package like uvx run does.

Please consider adding -m to uvx run or perhaps make that a default fallback behaviour if uvx run doesn't find an installed script.

[gotmax23]

uv run -m makes a lot of sense to me. You're trying to run a module.