Skip to content

hunttom/python_cli_skeleton

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

=======

A format for making a CLI

Decription for Making a CLI

Requirements:

  • Git
  • Python 3.6+

Usage

To Install:

Run make install to install from local repository

Run the following to install from GitHub: pip3 install git+https://github.com/FOO/REPO@main to install

To read the Help:

Run the following for help: --help at any level to see help: Examples: ENTRY_POINT --help or ENTRY_POINT list --help

To Use:

Run the following: ENTRY_POINT and the actions you want to perform:

Usage: ENTRY_POINT [OPTIONS] COMMAND [ARGS]...

  Main function for CLI

Options:
  --help              Show this message and exit.

Commands:
  help  ENTRY_POINT [--help ] # If configured help account

About

A template for creating Python CLI tools

Resources

License

Stars

Watchers

Forks

Packages

No packages published