Skip to content

Latest commit

 

History

History
220 lines (123 loc) · 5.21 KB

CHANGELOG.md

File metadata and controls

220 lines (123 loc) · 5.21 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project tries to adhere to Semantic Versioning.

Historic and pre-release versions aren't necessarily included.

0.13.1 - 2024-11-19

Changed

  • Remove upper bound on Python version
  • Docs: add intro, highlight Event and Group classes
  • Tests: instantiate with MyClass(**dict) instead of Pydantic internals; refactor fixtures

0.13.0 - 2024-11-04

Added

Changed

  • Update dev dependencies: mypy, ruff
  • Docs: don't document Pydantic internals

0.12.0 - 2024-10-11

Added

  • Add Profile to public API, with additional attributes: email, first_name, last_name, phone_nunber, property full_name
  • Support for Python 3.13
  • Docs: pdoc-generated HTML documentation in /docs

Changed

  • Update dev dependencies: pdoc, pre-commit, ruff
  • Dependencies: remove pydantic version upper bound

0.11.2 - 2024-09-16

Fixed

  • Hotfix: pdoc wouldn't render; solved by setting Pydantic dependency < 2.9

0.11.1 - 2024-09-16

Added

  • Tests for Group.member|role|subgroup_by_id() when Group.members|roles|subgroups is empty

Changed

  • Dev dependencies: add pdoc; update mypy, ruff, pytest

Removed

  • Explicit dependency on spond

0.11.0 - 2024-07-17

Added

  • Event attributes: cancelled, created_time, end_time, invite_time, type, property url

Changed

  • Public API is defined using __all__ instead of import aliasing, which improves e.g. documentation handling in IDEs
  • Consistent pattern for all classes' string representation, including full uid
  • Simplified and improved docstrings
  • Dependencies: remove upper bounds for simplicity; drop redundant python-dateutil
  • Dev dependencies: drop redundant types-python-dateutil

Fixed

  • Tests didn't import from the top-level namespace, i.e. didn't use public API

0.10.1 - 2024-07-02

Changed

  • Update dev dependencies: ruff, pre-commit-hooks

Fixed

  • Docs: licence classifier, docstring omissions, backticks and paragraph breaks

0.10.0 - 2024-06-19

Changed

  • Dependencies: allow spond >= 1

0.9.2 - 2024-06-09

Changed

  • Group.members_by_role|subgroup() raises ValueError if passed instances aren't compatible
  • Tests for Group.member|role|subgroup_by_id(), Group.members_by_role|subgroup()
  • Update dev dependency: pre-commit-hooks

Fixed

  • Example code in README

0.9.1 - 2024-05-10

Changed

  • Docstring and README improvements

Fixed

  • Member, Role, Subgroup removed in error from top-level namespace
  • Docstring and README errors

0.9.0 - 2024-05-09

Changed

  • BREAKING CHANGES: Significantly revised API - see README for details
  • Rewritten from scratch using Pydantic; much closer to API data structure

Removed

  • Support for Python 3.8, 3.9

0.8.1 - 2024-05-03

Added

  • Support for Python 3.12 in GitHub CI

Changed

  • Refactors; test improvements
  • Use ruff format instead of isort + black in CI/pre-commit
  • Update dev/test dependencies: mypy, pre-commit-hooks, pytest, ruff, types-python-dateutil
  • Update CI dependencies: actions/setup_python

Fixed

  • Member.__repr__ follows same pattern as other classes

Removed

  • dev/test dependencies: black, isort

0.8.0 - 2023-11-25

Added

  • Member.email, .phone_number, .profile_uid attributes

Changed

  • Simplify/rearrange tests
  • Update dev/test dependencies: black, mypy, pytest, ruff, types-python-dateutil

0.7.3 - 2023-09-27

Added

  • Documentation: Update README for install from PyPI instead of GitHub

Fixed

  • Missing/outdated/broken package metadata

0.7.2 - 2023-09-26

Added

  • Documentation: This changelog
  • Enforce linting with isort, black and ruff in CI using GitHub Actions

Changed

  • Update dev/test dependencies: ruff