Merged
Conversation
jtbandes
approved these changes
Aug 8, 2025
| @@ -0,0 +1,3 @@ | |||
| from .api import Client, FoxgloveException, OutputFormat | |||
|
|
|||
| __all__ = ["Client", "FoxgloveException", "OutputFormat"] | |||
Member
There was a problem hiding this comment.
does this actually change anything when those 3 names are exactly the ones that have already been imported?
Contributor
Author
There was a problem hiding this comment.
Nope, I can remove it.
Contributor
Author
There was a problem hiding this comment.
Flake8 complains about unused imports in that case; I left this in place rather than ignoring the warning.
| python_requires = >=3.7 | ||
|
|
||
| [options.packages.find] | ||
| include = foxglove* |
Member
There was a problem hiding this comment.
does this mean we were previously including tests in the published package? 🤔
Contributor
Author
There was a problem hiding this comment.
no, I think it's different behavior with find_namespace
mguida22
approved these changes
Aug 11, 2025
Contributor
Author
|
I added a minor version bump for the next release: 0.16.2->0.17.0 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changelog
Release as a namespace package. This should have no effect on most users.
Docs
None
Description
This converts foxglove-client to an implicit namespace package for better compatibility with the Foxglove SDK. The SDK also uses the
foxglovenamespace, and currently can't be installed alongside foxglove-client without workarounds.foxglove/__init__.pyis removed, and all code is moved into aclientsub-package. I put the core code inclient/api.pyso as not to have everything in the init file.For most users, this should not be a breaking change. Usage from the example remains the same: basically,
from foxglove.client import Client.Only the contents of
__all__are exported from the client package. Other symbols (DEFAULT_DECODER_FACTORIES,camelize,bool_query_param,without_nulls) appear to be for internal use, so I explicitly didn't re-export them. This is a breaking change for anyone who uses them, and I did so intentionally to avoid polluting the primary package. These can now be imported fromfoxglove.client.apiif needed. There may be some other edge cases that would break — e.g. relying on file or path locations — but I can't think of any likely cases.