OpenwaterHealth/openlifu-python

use `__all__` in the `__init__.py`s

Open

#12 opened on Jun 17, 2024

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Python (16 forks)auto 404
good first issue

Repository metrics

Stars
 (24 stars)
PR merge metrics
 (PR metrics pending)

Description

With __all__ we can be more explicit about what it is that a package "exports"

See https://setuptools.pypa.io/en/latest/userguide/dependency_management.html#optional-dependencies

Contributor guide

Research direction
Add ` all ` variable to each ` init .py` file to explicitly list public exports. Refer to the setuptools documentation on optional dependencies if needed.
Tech stack
python
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70