Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generator CLI args in docs #9

Open
nelson-lojo opened this issue May 31, 2023 · 2 comments
Open

Generator CLI args in docs #9

nelson-lojo opened this issue May 31, 2023 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation fppgen about FPP generator

Comments

@nelson-lojo
Copy link
Contributor

"""In the case where we pass something along the command line, the tool looks for source files in the argument if it is a directory or tries to interpret the argument as source of it is a file"""

@nelson-lojo nelson-lojo self-assigned this May 31, 2023
@nelson-lojo nelson-lojo added the documentation Improvements or additions to documentation label May 31, 2023
@nelson-lojo
Copy link
Contributor Author

From #18 (--output-path, --make-dir, --quiet, --verbose:

Added two command-line (and metadata fields) to allow control over output location. Command-line arguments are used in the case where both are given

  • --output-path allows a parent path for generated questions to go (alias -o)
    • default: next to the source file
    • metadata respective field: "output-path" : str
    • an empty value for this field uses the default value
    • e.g. course/question_src_files/ $ generate_fpp.py --output-path ../questions/ ./my_fpp_question.fpp produces course/questions/my_fpp_question/ and puts question files inside of that directory
  • --make-dir is a flag whose presence says to explicitly create a directory with the question name (name of the source file) in the output path
    • default: true
    • metadata respective field: "make-dir" : bool
    • cli flags for negation: --no-make-dir, --no-duplicate-directories
    • e.g. questions/fpp_question/ $ generate_fpp.py --no-make-dir source_file.fpp produces a question inside of questions/fpp_question/ and NOT inside of questions/fpp_question/source_file/

Default behavior (create directory next to source path with source file name and write inside of it) is maintained.

@nelson-lojo
Copy link
Contributor Author

Additionally, a change from --no-parse to --parse

@SybelBlue SybelBlue added the fppgen about FPP generator label Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation fppgen about FPP generator
Projects
None yet
Development

No branches or pull requests

2 participants