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 options flow to OpenSky #98177

Merged
merged 10 commits into from Aug 22, 2023
Merged

Add options flow to OpenSky #98177

merged 10 commits into from Aug 22, 2023

Conversation

joostlek
Copy link
Member

@joostlek joostlek commented Aug 10, 2023

Proposed change

Add Options flow to Opensky.

In the options flow, users can fill in their username and password to authenticate and upgrade their update interval.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Black (black --fast homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

Copy link
Contributor

@edenhaus edenhaus left a comment

Choose a reason for hiding this comment

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

We should either allow the user to insert a username/password during the initial config flow or update the docs to inform the user about the ability to configure the username/password.
Otherwise, the user doesn't know about it.

@home-assistant home-assistant bot marked this pull request as draft August 14, 2023 13:49
@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@joostlek
Copy link
Member Author

Oh right, I still have to open a docs PR. Did you take a look at the rest of the code already?

@edenhaus
Copy link
Contributor

Oh right, I still have to open a docs PR. Did you take a look at the rest of the code already?

Yes, the rest is fine. I wanted to know if you prefer to open a docs PR or add the username/password to the initial setup.

@joostlek
Copy link
Member Author

I think I prefer this way as it's not needed for the API to be authenticated, this way I don't force all users to login to a service they never had to

@joostlek joostlek closed this Aug 20, 2023
@joostlek joostlek reopened this Aug 20, 2023
@joostlek joostlek marked this pull request as ready for review August 20, 2023 21:03
@home-assistant home-assistant bot requested a review from edenhaus August 20, 2023 21:03
@frenck frenck added the smash Indicator this PR is close to finish for merging or closing label Aug 21, 2023
@edenhaus edenhaus merged commit 19576e6 into home-assistant:dev Aug 22, 2023
24 of 35 checks passed
@joostlek joostlek deleted the opensky_auth branch August 22, 2023 16:24
@github-actions github-actions bot locked and limited conversation to collaborators Aug 23, 2023
@joostlek joostlek added the noteworthy Marks a PR as noteworthy and should be in the release notes (in case it normally would not appear) label Sep 5, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
by-code-owner cla-signed has-tests integration: opensky new-feature noteworthy Marks a PR as noteworthy and should be in the release notes (in case it normally would not appear) Quality Scale: No score smash Indicator this PR is close to finish for merging or closing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants