Pythagora-io/gpt-pilot

refactor `arguments.py` to use `argparse`

Open

#138 opened on Oct 6, 2023

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Python (27,167 stars) (2,685 forks)batch import
documentationenhancementgood first issue

Description

argparse makes it easier to provide help/documentation on the command line and also provides choices, default and type

It also returns an object rather than a dict. There are currently arg options scattered throughout the code which are not mentioned in arguements.py

Contributor guide

Tech stack
python
Domain
cli
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Python basicsargparse
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
The main file to modify is `arguments.py` located in the repository. The goal is to replace the current argument handling (likely using `sys.argv` or similar) with `argparse` to provide better help and validation. Contributors should also look for other places where command line arguments are handled outside of `arguments.py` as mentioned in the issue. Ensure that all existing functionality is preserved and that the new implementation returns an object instead of a dict.