Skip to content

zephyr834/cli_template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Myapp: A CLI Application.

Description:

Built on: Python3 - 3.11.9 Mac

Commands

  • myCommand TITLE DESCRIPTION : myCommand does something

Install

pip3 install git+https://github.com/username/myapp

Usage:

  • Add a task

    $ myApp myCommand "Pet a cat" "Petting the feline friend"
    
    |  UID  |             Title             |          Description          |   Status  |           Created At          |           Updated At          |
    |   1   |           Pet a cat           |   Petting the feline friend   |    todo   |   October 02, 2024 03:51 PM   |   October 02, 2024 03:51 PM   |

Setup source code

The following steps are for cloning, modifying, testing the code.

  • Clone
git clone git@github.com:username/myapp.git
  • Setup virtual env
python3 -m venv venv
source ./venv/bin/activate
  • Install Requirements
pip3 install -r requirements.txt
  • Run CLI
python3 app/main.py [OPTIONS] COMMAND [ARGS]
  • Run tests
pytest
  • Debugging If running the tests creates a "ModuleNotFoundError", run the following command in your virtual env.
export PYTHONPATH=$PYTHONPATH:$(pwd)/app

About

Python CLI Application utilizing Click

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages