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.

Sign up for GitHub

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

Jump to bottom

feat: Check setup #181

Merged
merged 11 commits into from May 4, 2020
Merged

feat: Check setup #181

merged 11 commits into from May 4, 2020

Conversation

KitBurgess
Copy link
Contributor

@KitBurgess KitBurgess commented May 1, 2020 •
edited

Provide an automated script so that clients can easily check whether the SDK is setup correctly, and ready to use.

Closes #180

It goes like this:

pip install vortexasdk
python -m vortexasdk.check_setup

@KitBurgess
Copy link
Contributor Author

Full example usage

(Note the --pre is only required right now because the sdk version 0.16.0alpha3 is a pre-release).

image

@KitBurgess KitBurgess marked this pull request as ready for review May 1, 2020 12:35
cvonsteg
cvonsteg reviewed May 1, 2020
View reviewed changes
README.md Outdated Show resolved Hide resolved
cvonsteg
cvonsteg reviewed May 1, 2020
View reviewed changes
docs/faq_setup.md Outdated Show resolved Hide resolved
cvonsteg
cvonsteg suggested changes May 1, 2020
View reviewed changes
Copy link
Contributor

@cvonsteg cvonsteg left a comment

Choose a reason for hiding this comment

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

Looks good, like the idea of a setup check. Just want to confirm the syntax for running the script in python -m mode

asfakianakis
asfakianakis approved these changes May 4, 2020
View reviewed changes
Copy link
Contributor

@asfakianakis asfakianakis left a comment

Choose a reason for hiding this comment

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

Those checks are super cool! They facilitate debugging and improve UX as well.

@KitBurgess KitBurgess merged commit b67c0f0 into master May 4, 2020
@KitBurgess KitBurgess deleted the healthcheck-script branch May 4, 2020 11:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@asfakianakis asfakianakis asfakianakis approved these changes

@ChristianBorresen ChristianBorresen Awaiting requested review from ChristianBorresen

@andreagerino andreagerino Awaiting requested review from andreagerino

@cvonsteg cvonsteg Awaiting requested review from cvonsteg

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add connectivity / healthcheck script.
3 participants
@KitBurgess @cvonsteg @asfakianakis