Building Command-Line Tools with Python: A Practical Guide

What to do:

1. Install Python 3.8+ from python.org.
2. Create a virtual environment:
   bash

   python -m venv venv
   source venv/bin/activate  # On Windows: venv\Scripts\activate

Example:

Your shell prompt should show (venv) when activated.

What to do:

1. Write a script that accepts arguments:
   python

   import argparse
   
   parser = argparse.ArgumentParser(description='Greet the user.')
   parser.add_argument('--name', required=True, help='Your name')
   args = parser.parse_args()
   print(f'Hello, {args.name}!')

Example:

Run python greet.py --name Alice to see the greeting.

What to do:

1. Add subcommands for different actions:
   python

   parser = argparse.ArgumentParser(description='Todo CLI')
   subparsers = parser.add_subparsers(dest='command')
   
   add_parser = subparsers.add_parser('add', help='Add a todo')
   add_parser.add_argument('task')
   
   list_parser = subparsers.add_parser('list', help='List todos')
   
   args = parser.parse_args()
   if args.command == 'add':
       print(f'Added: {args.task}')
   elif args.command == 'list':
       print('Listing todos...')

Example:

Try python todo.py add "Buy milk" and python todo.py list.

What to do:

1. Install click:
   bash

   pip install click

2. Create a click-based CLI:
   python

   import click
   
   @click.group()
   def cli():
       pass
   
   @cli.command()
   def hello():
       click.echo('Hello from click!')
   
   if __name__ == '__main__':
       cli()

Example:

Run python cli.py hello to see the output.

What to do:

1. Use click's color features:
   python

   @cli.command()
   def warn():
       click.secho('Warning!', fg='yellow', bold=True)

Example:

The warning message appears in yellow and bold.

What to do:

1. Add a setup.py file:
   python

   from setuptools import setup
   
   setup(
     name='mycli',
     py_modules=['cli'],
     install_requires=['click'],
     entry_points='''
       [console_scripts]
       mycli=cli:cli
     ''',
   )

2. Install your CLI locally:
   bash

   pip install -e .

Example:

Now you can run mycli hello from anywhere.

What to do:

1. Write tests using pytest:
   python

   def test_hello(runner):
       result = runner.invoke(cli, ['hello'])
       assert 'Hello' in result.output

2. Add a README.md with usage examples.

Example:

A good README and tests make your project stand out on GitHub.