Skip to content

Switch from structopt to clap #141

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

Merged
merged 1 commit into from
Oct 3, 2022
Merged

Switch from structopt to clap #141

merged 1 commit into from
Oct 3, 2022

Conversation

Celeo
Copy link
Contributor

@Celeo Celeo commented Oct 3, 2022

Fixes #140.

Description

Replaces structopt with clap.

Without any additional formatting changes, this is how the help output is now written:

configuration for AWS S3 SDK

Usage: parseable [OPTIONS]

Options:
      --s3-endpoint-url <S3_ENDPOINT_URL>
          The endpoint to AWS S3 or compatible object storage platform [env: P_S3_URL=] [default: https://minio.parseable.io:9000]
      --s3-access-key-id <S3_ACCESS_KEY_ID>
          The access key for AWS S3 or compatible object storage platform [env: P_S3_ACCESS_KEY=] [default: minioadmin]
      --s3-secret-key <S3_SECRET_KEY>
          The secret key for AWS S3 or compatible object storage platform [env: P_S3_SECRET_KEY=] [default: minioadmin]
      --s3-default-region <S3_DEFAULT_REGION>
          The region for AWS S3 or compatible object storage platform [env: P_S3_REGION=] [default: us-east-1]
      --s3-bucket-name <S3_BUCKET_NAME>
          The AWS S3 or compatible object storage bucket to be used for storage [env: P_S3_BUCKET=] [default: parseable]
  -h, --help
          Print help information

This PR has:

  • been tested to ensure log ingestion and log query works.
  • added comments explaining the "why" and the intent of the code wherever would not be obvious for an unfamiliar reader.
  • added documentation for new or modified features or behaviors.

@nitisht nitisht requested a review from trueleo October 3, 2022 04:32
@nitisht
Copy link
Member

nitisht commented Oct 3, 2022

Thank you for the PR, @Celeo we'll review and take it soon.

Copy link
Contributor

@trueleo trueleo left a comment

Choose a reason for hiding this comment

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

Thank you for your kind work. 🎉

@nitisht nitisht merged commit d72ce98 into parseablehq:main Oct 3, 2022
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.

Move from structopt to clap
3 participants