Skip to content

Make important classes/functions available at the root project level via up-importing through __init__ files #25

@tipatterson-dev

Description

@tipatterson-dev

Currently, accessing key classes in the project requires importing from deep submodules. To improve developer experience and make the API more user-friendly, expose the most important classes at the root level of the package by up-importing them through the appropriate __init__.py files.

Proposed Steps:

  • Identify the most critical classes that should be available for import from the root project level (e.g., from oshconnect import ImportantClass).
  • Update the relevant __init__.py files to re-export these classes at the package root.
  • Update documentation/examples to reflect the new import paths.

Benefits:

  • Simplifies usage for newcomers and existing users.
  • Provides a cleaner and more discoverable API surface.

Acceptance Criteria:

  • Key classes can be imported directly from the project root.
  • Documentation and usage examples are up to date.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions