Skip to content

Repository polish: type hints, logging, and API cleanup#18

Merged
roesel merged 3 commits into
mainfrom
roesel/repo-polish-plan
Feb 22, 2026
Merged

Repository polish: type hints, logging, and API cleanup#18
roesel merged 3 commits into
mainfrom
roesel/repo-polish-plan

Conversation

@roesel

@roesel roesel commented Feb 22, 2026

Copy link
Copy Markdown
Owner

Summary

  • Type hints added across all modules
  • print() replaced with logging
  • Motor inherits from ABC; ContinuousMotor uses @AbstractMethod
  • Internal utils removed from public API
  • py.typed PEP 561 marker added
  • Docs: badges, typo fixes, version/copyright updates

Annotate ~80 function/method signatures with parameter and return types.
Define a Status type alias in tools.py used throughout the codebase.
Add `from __future__ import annotations` for modern union syntax.
Add PyPI, Python version, CI, docs, and license badges to README.
Fix "opne" → "open" typo in README and Sphinx docs. Close unclosed
<a> tag on Ko-fi button. Update Sphinx conf.py version (0.0.1 → 0.0.6)
and copyright year (2022 → 2022-2025).
…method

- Remove is_null_or_empty, parse, s32, error_check, move_check from
  __init__.py exports to narrow the public API surface
- Make Motor inherit from ABC
- Use @AbstractMethod for ContinuousMotor's _pos_to_unit and _unit_to_pos
- Add py.typed PEP 561 marker file
@roesel
roesel merged commit 36d3865 into main Feb 22, 2026
2 checks passed
@roesel
roesel deleted the roesel/repo-polish-plan branch February 22, 2026 20:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant