Modernize (#6)

[Layf21]

Release

his release focuses on code quality, standardization, and tooling improvements. It contains minimal new features or bugfixes.

The most significant change (apart from the breaking changes) is the switch from CalVer to SemVer.
I will yank all CalVer versions from pypi.
This version will come after version 2024.1.3. You can still install the old version with pip install froeling-connect==2024.1.3

I am aware that this is an unusual decision, but I really regretted choosing CalVer. Additionally, I published a 2024 version in 2025. I decided to make this switch while the amount of users is still relatively low.

Changes

Breaking changes

• Switched versioning system from CalVer to SemVer
• Component.parameters is now of type dict[str, Parameter] with parameter ids as keys
• Attributes are now all snake_case instead of camelCase:
  • Facility
    • equipmentNumber -> equipment_number
    • allowMessages -> allow_messages
    • allowMessages -> allow_messages
    • subscribedNotifications -> subscribed_notifications
    • pictureUrl -> picture_url
    • protocol3200Info -> protocol_3200_info
    • hoursSinceLastMaintenance -> hours_since_last_maintenance
    • operationHours -> operation_hours
    • facilityGeneration -> facility_generation
  • UserData
    • pictureUrl -> picture_url
    • facilityCount -> facility_count

Build & Packaging

• Switch to Hatch build system
• Switched to dynamic versioning with hatch-vcs (fallback 0.0.0)
• Removed requirements.txt

CI/CD & Automation

• Add CI workflow
• Added bump-version workflow
• Added publish workflow
• Added version-tagging workflow

Code Quality & Tooling

• Add pre-commit hooks
• Add Ruff linting and formatting
• Added typehints and mypy typechecking
• Added Docstrings
• Many smaller improvements to make the codebase pass all quality tests

Tests & Examples

• Added tests
• Overhaul example.py

Documentation

• Overhaul README.md