Skip to main content

Creating command line utility in python



Learning Sections          show

Creating Command Line Utility in Python

Introduction

Creating a command line utility in Python can simplify tasks and automate workflows. Python provides several libraries to help create command line interfaces (CLI) easily, such as argparse, click, and typer.

Using argparse

The argparse module is part of the Python standard library and helps create simple to complex command line interfaces.

Example with argparse

import argparse

# Create the parser
parser = argparse.ArgumentParser("CLI Example")

# Add arguments
parser.add_argument("--name", type=str, required=True, help="Name of the user")
parser.add_argument("--age", type=int, help="Age of the user")

# Parse the arguments
args = parser.parse_args()

# Use the arguments
print(f"Name: {args.name}")
print(f"Age: {args.age}")

Using click

The click library is a package for creating command line interfaces in a composable way with as little code as necessary.

Example with click

import click

@click.command()
@click.option("--name", prompt="Your name", help="Name of the user")
@click.option("--age", default=0, help="Age of the user")
def cli(name, age):
    click.echo(f"Name: {name}")
    click.echo(f"Age: {age}")

if __name__ == "__main__":
    cli()

Using typer

The typer library is a newer library for creating command line interfaces. It's designed to be easy to use and leverages Python's type hints.

Example with typer

import typer

app = typer.Typer()

@app.command()
def cli(name: str, age: int = 0):
    typer.echo(f"Name: {name}")
    typer.echo(f"Age: {age}")

if __name__ == "__main__":
    app.run()
Labels:

Popular posts from this blog

Introduction to OOPs in Python

  Learning Sections          show Introduction to Object-Oriented Programming (OOP) Object-Oriented Programming (OOP) is a programming paradigm that organizes software design around objects rather than actions and data rather than logic. It revolves around the concept of "objects", which are instances of classes. These objects encapsulate data, in the form of attributes or properties, and behaviors, in the form of methods or functions. OOP promotes modularity, reusability, and extensibility in software development. Key Concepts of OOP: Class: A class is a blueprint or template for creating objects. It defines the attributes (data) and methods (functions) that will characterize any object instantiated from that class. Object: An object is an instance of a class. It is a concrete realization of the class blueprint, containing actual values instead of placeholders for attributes. Encapsulation: Encapsulation is ...
Read more

Inheritance in Python

  Learning Sections          show Inheritance in Python Inheritance is a fundamental concept in object-oriented programming (OOP) that allows a class to inherit attributes and methods from another class. The class that inherits is called the child class or subclass, and the class being inherited from is called the parent class or superclass. Basic Inheritance In Python, a child class inherits from a parent class by specifying the parent class in parentheses after the child class name. Example: class Animal : def __init__ ( self , name ): self . name = name def speak ( self ): raise NotImplementedError ( "Subclass must implement this method" ) class Dog ( Animal ): def speak ( self ): return "Woof!" class Cat ( Animal ): def speak ( self ): return "Meow!" # Create instances of Dog and Cat dog = Dog ( "Buddy" ) cat = Cat ( "Whiskers" ...
Read more

AsyncIO in Python

  Learning Sections          show AsyncIO in Python AsyncIO is a library to write concurrent code using the async/await syntax. It allows you to manage asynchronous tasks and I/O operations in Python. Basics of AsyncIO AsyncIO provides an event loop, coroutines, and tasks: Event loop: The core of every asyncio application. It runs asynchronous tasks and callbacks. Coroutines: Special functions defined with async def . They use await to pause their execution and wait for other coroutines. Tasks: Used to schedule coroutines to run concurrently in the event loop. Creating a Simple Coroutine import asyncio # Define a coroutine async def say_hello (): print ( "Hello" ) await asyncio.sleep ( 1 ) print ( "World" ) # Create an event loop and run the coroutine asyncio.run ( say_hello ()) Running Multiple Coroutines import asyncio async de...
Read more