CODEWITHSUNDEEP
pythonpython-3.xshellterminalcommand
n0x
n0x

Reputation: 9

How do I create terminal commands in my python script?

I want to create terminal commands in my python script.

for example,

$ cd my_project_folder
$ --help (I use a command in this python folder)

outputs
$ this is the help command. You've activated it using --help. This is only possible because you cd'd to the folder and inputted this command.

I am looking for user defined commands ( ones that I've already defined in my python function.)

I am not looking for commands like 'ls' and 'pwd'.

Upvotes: 1

Views: 702

Answers (3)

Leemosh
Leemosh

Reputation: 905

What you are looking for is creating a setup.py file and defining some entry points. I'd recommend watching https://www.youtube.com/watch?v=GIF3LaRqgXo&ab_channel=CodingTech or https://www.youtube.com/watch?v=4fzAMdLKC5ks&ab_channel=NextDayVideo to better understand how to deal with setup.py.

from setuptools import setup

setup(
    name="Name_of_your_app",
    version="0.0.1",
    desciption="some description",
    py_modules=["app"], # I think you don't need that
    package_dir={"": "src"}, # and probably you don't need this as well
    entry_points={"console_scripts": {"THIS_IS_THE_DEFINED_COMMAND=app:main"}},
)

app is name of the py file, main is function you wanna call.

app.py

def main():
    print("hello")

Upvotes: 1

TheOriginalOdis
TheOriginalOdis

Reputation: 102

Use os module if you wanna execute command that is specific to bash or shell that you use

import os
os.system("string command")

As Leemosh sugested you can use click module to make your own commands that are related to scripts

And you can also use sys module to read args that you put affter your script example

$ python3 name_of_script.py arg_n

import sys
if sys.argv[1] == "commnd":
    do something

Upvotes: 1

IoaTzimas
IoaTzimas

Reputation: 10624

You can use os.system, as below:

import os
os.system('your command')

Upvotes: 2

Related Questions