Mapping a custom a CLI command to a Python script

Question

I have a python script, let's call it my_script.py. The script is supposed to generate simulated responses to an api call performed on the command line.

What I am looking for is some way to have a custom command line command, e.g. run-my-script execute my_script.py while allowing for my_script.py to accept keyword arguments.

It would be great to have a solution that doesn't require external libraries and that allows for keyword arguments to be passed from the command line to that function.

Is there a way to have a custom command on the command line, like run-my-script trigger my_script.py?

Though it would be easiest to just run python my_script.py from the command line, for my use case I need to have the python script triggered just by run-my-script alone.

You can rename your script to run-my-script if you already have the shebang line, then copy it to somewhere on your path. — Selcuk
– Selcuk, Commented Jan 7, 2020 at 0:12
Like a shell script named run-my-script that itself runs python3 my_script.py "$@"? — jarmod
– jarmod, Commented Jan 7, 2020 at 0:18
@jarmod That is probably one solution. But it seems like more work than necessary since you can run my_script.py directly without a shell script wrapper. — Code-Apprentice
– Code-Apprentice, Commented Jan 7, 2020 at 0:48
@Code-Apprentice agreed, if the only thing the shell script does is exec the Python script. I figured it might be more complex than that, but maybe it isn’t. — jarmod
– jarmod, Commented Jan 7, 2020 at 0:51

aligumustosun · Accepted Answer · 2020-01-07 00:44:06Z

2

alias run-my-script="python my_script.py"

Run this command in terminal and run-my-script will execute my_script.py.

You can also add it in ~/.bashrc so you can access it after you reboot.

answered Jan 7, 2020 at 0:44

aligumustosun

16210 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Code-Apprentice · Accepted Answer · 2020-01-07 00:15:08Z

1

You should first add a shebang line to your Python script:

#!/usr/bin/env python3

Then you can run it directly from the command line as

$ my_script.py

If you want the command to be something else, then just rename your file. If you want to run it from any directory, copy it to a directory that is already in you PATH or add it's parent directory to your PATH.

answered Jan 7, 2020 at 0:15

Code-Apprentice

84k26 gold badges162 silver badges289 bronze badges

Collectives™ on Stack Overflow

Mapping a custom a CLI command to a Python script

2 Answers 2

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related