A cli tool that makes any Python function an executable
Project description
Bistrot
A cli tool that transforms any Python function into an executable, or can easily print any constant in a codebase or library
It takes an existing Python function in a project and allows you to call it as an independent executable. All the function arguments become cli arguments with argparse.
Examples
Let's consider this example from examples/ops.py:
#examples/ops.py
def add(a: int, b: int) -> int:
return a + b
We can call this function from the command line using bistrot:
$ bistrot examples.ops:add --x=2 --y=3
bistrot> 5
It also works with static and class methods
#examples/klass.py
import bistrot
class UsefulClass:
@staticmethod
def version():
return bistrot.__version__
$ bistrot examples.klass:UsefulClass.version
bistrot> 0.1.0a1
The same result can be achieved by targeting directly the __version__
variable:
$ bistrot bistrot:__version__
bistrot> 0.1.0a1
It is also possible to call methods on strings
$ bistrot '{\"hello\"}:upper'
bistrot> HELLO
Install
Bistrot is on pypi and it has no dependencies! Install it simply with
$ pip install bistrot
Or you may want to install it with pipx
for global usage
$ pipx install bistrot
$ bistrot <cmds>
And verify your installation with
$ bistrot --version
bistrot> 0.1.0a1
Warning
This project is still experimental and is guaranteed to work only with primitive Python types.
Links
- Source Code: https://github.com/mattiadg/bistrot
- PyPI Releases: https://pypi.org/project/bistrot/
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for bistrot-0.1.0a2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a76496f208afa57c7e25fcfc285a0fabd345faefcc74dcff5fa5be59b0240d08 |
|
MD5 | 99cb9e863b7540dc419630cd4488249d |
|
BLAKE2b-256 | 69f3a700cd230724265e678a68c53d4787f16e2db3581b848a885178d1b9c79e |