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

Setup CLI functionality for i18n-check #4

Open
2 tasks done
andrewtavis opened this issue Dec 28, 2024 · 4 comments
Open
2 tasks done

Setup CLI functionality for i18n-check #4

andrewtavis opened this issue Dec 28, 2024 · 4 comments
Labels
feature New feature or request help wanted Extra attention is needed

Comments

@andrewtavis
Copy link
Member

Terms

Description

The basic idea of i18n-check is that it will function as a CLI. We should leverage argparse to bring in arguments for the CLI, but the main usage of the package will not be argument based. Rather we want the user to be able to do the following in the command line:

i18n-check

From here the CLI would check an i18n_check_config.yaml file for the arguments needed for the checks, which would then be ran. Arguments for the CLI would be:

  • -h / --help (we'd need to change the first letter of the help message to being capitalized)
  • -v / --version (check the version of the CLI)
  • -u / --upgrade (upgrades to the latest version)
  • -cc / --create-config (an interactive prompt to then create a config file at the end)
    • This would include placeholders to suggest common structures

The -cc functionality would also automatically be ran if the user tries to use the check without a config file.

Contribution

Happy to discuss this and review the work when a PR is opened! 🚀

@andrewtavis andrewtavis added help wanted Extra attention is needed feature New feature or request labels Dec 28, 2024
@andrewtavis
Copy link
Member Author

CC @OmarAI2003 👋 Let me know if there are questions on the above! :) Great to have you in the sync! 😊

@andrewtavis
Copy link
Member Author

I think that these changes can go in a scr/i18n-check/cli.py file, and we can follow the src/scribe_data/cli/main.py for this :)

@OmarAI2003
Copy link
Contributor

CC @OmarAI2003 👋 Let me know if there are questions on the above! :) Great to have you in the sync! 😊

Hi @andrewtavis ,of course! I've got a lot of questions, and I'm excited to start on this. However, I have three exams left, so I’ll begin working on this seriously by the 7th of January.

Also, ideally, I should do the test related #2 issue before starting this right?

@andrewtavis
Copy link
Member Author

You can work on this or #2 beforehand, @OmarAI2003 :) Whatever works best for you 😊 Let's check in in the new year after your tests, and good luck on them! 😊

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request help wanted Extra attention is needed
Projects
Status: Todo
Development

No branches or pull requests

2 participants