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

add help behavior #45

Merged
merged 1 commit into from
Jan 10, 2025
Merged

add help behavior #45

merged 1 commit into from
Jan 10, 2025

Conversation

aaroncherian
Copy link
Contributor

@aaroncherian aaroncherian commented Jan 9, 2025

Adding a help argument to skelly_synchronize

To test:

  1. Create a fresh install of skelly_synchronize for this PR
  2. Try skelly_synchronize--help
  3. Try 'python -m skelly_synchronize --help`

for 2 and 3 you should get a print statement that reads:

(skelly_synchronize) C:\Users\aaron\Documents\GitHub\skelly_synchronize>skelly_synchronize --help
13:13:33 ::   Utilities   ::   INFO   :: Running DeFFcode Version: 0.2.6
adding base_package_path: C:\Users\aaron\Documents\GitHub\skelly_synchronize : to sys.path
[2025-01-09 13:13:33.0661] [    INFO] [skelly_synchronize.system.logging_configuration] [configure_logging():39] [PID:28888 TID:37552] Added logging handlers: [<StreamHandler <stdout> (INFO)>, <FileHandler C:\Users\aaron\skelly_synchronize_data\logs_info_and_settings\logs\log_2025-01-09T13_13_33ms659_gmt-5.log (INFO)>]
adding base_package_path: C:\Users\aaron\Documents\GitHub\skelly_synchronize : to sys.path
usage: skelly_synchronize [-h]

Skelly Synchronize

options:
  -h, --help  show this help message and exit

NOTE: I changed the entry point in the pyproject.toml in order to get skelly_synchronize --help to work in addition to python -m skelly_synchronize --help

@philipqueen philipqueen self-requested a review January 10, 2025 05:31
Copy link
Collaborator

@philipqueen philipqueen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works as expected!

Note that there's a space needed between skelly_synchronize and --help, in case anyone else is testing

@aaroncherian
Copy link
Contributor Author

Works as expected!

Note that there's a space needed between skelly_synchronize and --help, in case anyone else is testing

Edited the original to fix this issue

@aaroncherian aaroncherian merged commit f30824f into main Jan 10, 2025
1 check passed
@aaroncherian aaroncherian deleted the aaron/add_help_behavior branch January 10, 2025 17:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants