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

Provide a --help command when calling chasten alone #43

Closed
CalebKendra opened this issue Sep 7, 2023 · 6 comments · Fixed by #48
Closed

Provide a --help command when calling chasten alone #43

CalebKendra opened this issue Sep 7, 2023 · 6 comments · Fixed by #48
Assignees
Labels
enhancement New feature or request in-progress Work is actively happening on this issue

Comments

@CalebKendra
Copy link
Collaborator

Right now when you run the command chasten an error message appears. the chasten command should show chasten --help's output just like other similar programs like pip.

@CalebKendra CalebKendra added the enhancement New feature or request label Sep 7, 2023
@CalebKendra CalebKendra self-assigned this Sep 7, 2023
@gkapfham
Copy link
Collaborator

Hi @CalebKendra, I think that this is a really good idea! Can you investigate how you would implement this feature? Finally, what type of information would you want to provide? Here is what I see when I type chasten --help:

╭─ Options ─────────────────────────────────────────────────────────────╮
│ --install-completion          Install completion for the current      │
│                               shell.                                  │
│ --show-completion             Show completion for the current shell,  │
│                               to copy it or customize the             │
│                               installation.                           │
│ --help                        Show this message and exit.             │
╰───────────────────────────────────────────────────────────────────────╯
╭─ Commands ────────────────────────────────────────────────────────────╮
│ analyze               💫 Analyze the AST of Python source code.       │
│ configure             🪂 Manage chasten's configuration.              │
│ datasette-publish     🌎 Publish a datasette to Fly or Vercel.        │
│ datasette-serve       🏃 Start a local datasette server.              │
│ integrate             🚧 Integrate files and make a database.         │
│ interact              🚀 Interactively configure and run.             │
│ log                   🦚 Start the logging server.                    │
╰───────────────────────────────────────────────────────────────────────╯

what are you seeing? What would you expect? If there is something else that you would want, please document it here.

@Jaclynpqc
Copy link
Collaborator

Hi Caleb, just a suggestion. I've seen some tools have this command tool --version. Perhaps we could integrate it into our program too?

@gkapfham
Copy link
Collaborator

Hi @Jaclynpqc, yes this is a really good idea. There is #12 that also hints at the need for a --version flag. Can one or both of you find out if the teams wants to implement this feature now and then get started on it?

@Jaclynpqc
Copy link
Collaborator

Yes, I could start finding an approach to this feature

@gkapfham
Copy link
Collaborator

Hi @Jaclynpqc, thanks! @CalebKendra, please consider whether or not you can help as well.

@CalebKendra
Copy link
Collaborator Author

I will help with the --version after I fix this issue, however, this current issue is my priority

As for the details of this project, I would expect to see the exact same output that you get when inputting chasten --help, when you input chasten, In order to do this I have been experimenting with directing the chasten command without any option selected to point towards the chasten --help command. I am still looking for the cleanest solution to this problem as I do not want to have to re-create the chasten --help menu.

@CalebKendra CalebKendra linked a pull request Sep 12, 2023 that will close this issue
@gkapfham gkapfham added the in-progress Work is actively happening on this issue label Sep 12, 2023
@simojo simojo added this to the Week 4 Features milestone Sep 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request in-progress Work is actively happening on this issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants