diff --git a/CHANGELOG.md b/CHANGELOG.md index 100fea5..730e1ba 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,12 +7,13 @@ and this project tries to adhere to [Semantic Versioning](https://semver.org/spe Historic and pre-release versions aren't necessarily included. -## [0.10.0] - 20204-07-15 + +## [0.10.0] - 2024-07-15 ### Changed - *BREAKING CHANGES:* - - `get_profile_info()` returns`ProfileInfo` `NamedTuple` instead of dict + - `get_profile_info()` returns`ProfileInfo` `NamedTuple` instead of dict - `get_manager_member_counts()` returns `ManagerMemberCounts` `NamedTuple` instead of dict - `club_manager_url_via_login()` renamed to `manager_url_via_login()` diff --git a/britishcycling_clubs/manager.py b/britishcycling_clubs/manager.py index c3fd27a..21643dc 100644 --- a/britishcycling_clubs/manager.py +++ b/britishcycling_clubs/manager.py @@ -54,7 +54,7 @@ def get_manager_member_counts( Raises ------ - `ValueError` : + ValueError : if zero 'active members' would be returned, as it's assumed this indicates an issue with data collection. """ @@ -103,6 +103,12 @@ def manager_url_via_login(club_id: str) -> str: ---------- club_id : From the URL used to access club pages. + + Returns + ------- + str + URL + """ return f"{_MANAGER_VIA_LOGIN_BASE_URL}{club_id}/" diff --git a/britishcycling_clubs/profile.py b/britishcycling_clubs/profile.py index d4792fd..3d4af49 100644 --- a/britishcycling_clubs/profile.py +++ b/britishcycling_clubs/profile.py @@ -30,7 +30,7 @@ def get_profile_info(club_id: str) -> ProfileInfo: Raises ------ - `ValueError` : + ValueError : if information can't be located. """ url = profile_url(club_id) @@ -53,6 +53,11 @@ def profile_url(club_id: str) -> str: ---------- club_id : From the URL used to access club pages. + + Returns + ------- + str + URL """ return f"{_PROFILE_BASE_URL}{club_id}/" diff --git a/pyproject.toml b/pyproject.toml index 72f82e9..cb66729 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -17,14 +17,14 @@ requests = ">=2.23.1" playwright = ">=1.39.0" [tool.poetry.group.dev.dependencies] -pdoc = "^14.5.0" -ruff = "^0.5.0" +pdoc = ">=14.6.0" +ruff = ">=0.5.7" [tool.poetry.group.test.dependencies] -mypy = "^1.7.1" -pytest = "^7.4.2" -types-requests = "^2.31.0.10" -types-beautifulsoup4 = "^4.12.0.7" +mypy = ">=1.11.1" +pytest = ">=7.4.4" +types-requests = ">=2.32.0" +types-beautifulsoup4 = ">=4.12.0" [tool.mypy] strict = true @@ -33,6 +33,9 @@ strict = true module = "playwright" disallow_untyped_calls = false +[tool.ruff] +target-version = "py38" # Ruff doesn't respect Python version in [tool.poetry.dependencies] + [tool.ruff.lint] select = ["ALL"]