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

Move hcloud.hcloud module to hcloud._client #207

Open
jooola opened this issue Jun 21, 2023 · 2 comments
Open

Move hcloud.hcloud module to hcloud._client #207

jooola opened this issue Jun 21, 2023 · 2 comments
Labels
enhancement New feature or request pinned
Milestone

Comments

@jooola
Copy link
Member

jooola commented Jun 21, 2023

Feature Request

Is your feature request related to a problem? Please describe.

The hcloud.hcloud module is set as if it can be used by users. We also reexport the Client class in hcloud/__init__.py.
To have a clear definition of what the API exports and what API are usable by users, we should probably hide the hcloud.hcloud module.

Describe the solution you'd like

I propose to move the hcloud.hcloud module to hcloud._client. The Client class is already reexported in hcloud/__init__.py so most of the user should already use the "new" path.

In addition we can properly define all the exported APIs using the __all__ array.

Teachability, Documentation, Adoption, Migration Strategy

This is a breaking change, should be done for v2.0.0.

@jooola jooola changed the title Move hcloud.hcloud module to hcloud._client or hcloud._hcloud Move hcloud.hcloud module to hcloud._client Jun 21, 2023
@jooola jooola added this to the 2.0.0 milestone Jun 21, 2023
@jooola jooola added the enhancement New feature or request label Jul 18, 2023
@github-actions
Copy link

This issue has been marked as stale because it has not had recent activity. The bot will close the issue if no further action occurs.

@github-actions github-actions bot added the Stale label Oct 16, 2023
@jooola jooola removed the Stale label Oct 17, 2023
Copy link

This issue has been marked as stale because it has not had recent activity. The bot will close the issue if no further action occurs.

@github-actions github-actions bot added the Stale label Jan 16, 2024
@jooola jooola added pinned and removed Stale labels Jan 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request pinned
Projects
None yet
Development

No branches or pull requests

1 participant