5.1.0

What’s changed

⬆️ Dependency updates

• [#145] Bump poetry from 2.0.0 to 2.0.1 in /.github/workflows in the patches-and-minor-upgrades group
• [#146] Bump pip from 24.3.1 to 25.0 in /.github/workflows
• [#147] Bump pip from 25.0 to 25.0.1 in /.github/workflows in the patches-and-minor-upgrades group
• [#148] Bump poetry from 2.0.1 to 2.1.1 in /.github/workflows in the patches-and-minor-upgrades group
• [#149] Bump poetry from 2.1.1 to 2.1.2 in /.github/workflows in the patches-and-minor-upgrades group
• [#150] Bump pip from 25.0.1 to 25.1 in /.github/workflows in the patches-and-minor-upgrades group
• [#151] Bump the patches-and-minor-upgrades group in /.github/workflows with 2 updates
• [#152] Bump urllib3 from 2.3.0 to 2.5.0
• [#153] Bump black from 24.10.0 to 25.1.0
• [#154] Bump the patches-and-minor-upgrades group with 2 updates
• [#155] Bump flake8 from 5.0.4 to 7.3.0
• [#156] Bump pytest-cov from 5.0.0 to 6.2.1
• [#157] Bump bandit from 1.8.5 to 1.8.6 in the patches-and-minor-upgrades group
• [#158] Bump pip from 25.1.1 to 25.2 in /.github/workflows in the patches-and-minor-upgrades group
• [#160] Bump actions/checkout from 4 to 5
• [#159] Bump poetry from 2.1.3 to 2.1.4 in /.github/workflows in the patches-and-minor-upgrades group
• [#162] Bump actions/setup-python from 5 to 6
• [#161] Bump the patches-and-minor-upgrades group with 2 updates
• [#164] Bump poetry from 2.1.4 to 2.2.0 in /.github/workflows in the patches-and-minor-upgrades group
• [#163] Bump pytest-cov from 6.3.0 to 7.0.0
• [#166] Bump poetry from 2.2.0 to 2.2.1 in /.github/workflows in the patches-and-minor-upgrades group
• [#165] Bump black from 25.1.0 to 25.9.0 in the patches-and-minor-upgrades group
• [#168] Bump pip from 25.2 to 25.3 in /.github/workflows in the patches-and-minor-upgrades group
• [#169] Bump black from 25.9.0 to 25.11.0 in the patches-and-minor-upgrades group
• [#170] Bump requests from 2.32.3 to 2.32.4
• [#171] Bump actions/checkout from 5 to 6
• [#172] Bump urllib3 from 2.5.0 to 2.6.0

5.0.0

What’s changed

🚨 Breaking changes

• [#143] Drop support for Python < 3.9 @hkraal

⬆️ Dependency updates

55 changes

• [#86] Bump gitpython from 3.1.35 to 3.1.37 @dependabot
• [#87] Bump pip from 23.2.1 to 23.3 in /.github/workflows @dependabot
• [#88] Bump urllib3 from 2.0.6 to 2.0.7 @dependabot
• [#89] Bump black from 23.9.1 to 23.10.0 @dependabot
• [#90] Bump pip from 23.3 to 23.3.1 in /.github/workflows @dependabot
• [#91] Bump black from 23.10.0 to 23.10.1 @dependabot
• [#92] Bump pytest from 7.4.2 to 7.4.3 @dependabot
• [#93] Bump poetry from 1.6.1 to 1.7.0 in /.github/workflows @dependabot
• [#94] Bump black from 23.10.1 to 23.11.0 @dependabot
• [#95] Bump poetry from 1.7.0 to 1.7.1 in /.github/workflows @dependabot
• [#96] Bump actions/setup-python from 4 to 5 @dependabot
• [#97] Bump bandit from 1.7.5 to 1.7.6 @dependabot
• [#98] Bump black from 23.11.0 to 23.12.0 @dependabot
• [#99] Bump pip from 23.3.1 to 23.3.2 in /.github/workflows @dependabot
• [#100] Bump black from 23.12.0 to 23.12.1 @dependabot
• [#101] Bump pytest from 7.4.3 to 7.4.4 @dependabot
• [#102] Bump gitpython from 3.1.37 to 3.1.41 @dependabot
• [#103] Bump actions/cache from 3 to 4 @dependabot
• [#104] Bump the patches-and-minor-upgrades group with 1 update @dependabot
• [#106] Bump black from 23.12.1 to 24.1.1 @dependabot
• [#105] Bump pytest from 7.4.4 to 8.0.0 @dependabot
• [#107] Bump pip from 23.3.2 to 24.0 in /.github/workflows @dependabot
• [#108] Bump release-drafter/release-drafter from 5 to 6 @dependabot
• [#109] Bump the patches-and-minor-upgrades group with 1 update @dependabot
• [#110] Bump the patches-and-minor-upgrades group with 1 update @dependabot
• [#111] Bump the patches-and-minor-upgrades group in /.github/workflows with 1 update @dependabot
• [#112] Bump the patches-and-minor-upgrades group with 1 update @dependabot
• [#113] Bump the patches-and-minor-upgrades group in /.github/workflows with 1 update @dependabot
• [#114] Bump the patches-and-minor-upgrades group with 2 updates @dependabot
• [#115] Bump the patches-and-minor-upgrades group with 1 update @dependabot
• [#116] Bump pytest-cov from 4.1.0 to 5.0.0 @dependabot
• [#117] Bump idna from 3.4 to 3.7 @dependabot
• [#118] Bump black from 24.3.0 to 24.4.0 in the patches-and-minor-upgrades group @dependabot
• [#119] Bump the patches-and-minor-upgrades group with 2 updates @dependabot
• [#120] Bump poetry from 1.8.2 to 1.8.3 in /.github/workflows in the patches-and-minor-upgrades group @dependabot
• [#121] Bump the patches-and-minor-upgrades group with 2 updates @dependabot
• [#123] Bump requests from 2.32.1 to 2.32.2 in the patches-and-minor-upgrades group @dependabot
• [#124] Bump requests from 2.32.2 to 2.32.3 in the patches-and-minor-upgrades group @dependabot
• [#125] Bump pytest from 8.2.1 to 8.2.2 in the patches-and-minor-upgrades group @dependabot
• [#127] Bump bandit from 1.7.8 to 1.7.9 in the patches-and-minor-upgrades group @dependabot
• [#126] Bump urllib3 from 2.0.7 to 2.2.2 @dependabot
• [#128] Bump pip from 24.0 to 24.1 in /.github/workflows in the patches-and-minor-upgrades group @dependabot
• [#129] Bump pip from 24.1 to 24.1.1 in /.github/workflows in the patches-and-minor-upgrades group @dependabot
• [#130] Bump certifi from 2023.7.22 to 2024.7.4 @dependabot
• [#131] Bump pip from 24.1.1 to 24.1.2 in /.github/workflows in the patches-and-minor-upgrades group @dependabot
• [#132] Bump pytest from 8.2.2 to 8.3.1 in the patches-and-minor-upgrades group @dependabot
• [#133] Bump pytest from 8.3.1 to 8.3.2 in the patches-and-minor-upgrades group @dependabot
• [#134] Bump pip from 24.1.2 to 24.2 in /.github/workflows in the patches-and-minor-upgrades group @dependabot
• [#135] Bump black from 24.4.2 to 24.8.0 in the patches-and-minor-upgrades group @dependabot
• [#136] Bump pytest from 8.3.2 to 8.3.3 in the patches-and-minor-upgrades group @dependabot
• [#137] Bump bandit from 1.7.9 to 1.7.10 in the patches-and-minor-upgrades group @dependabot
• [#138] Bump poetry from 1.8.3 to 1.8.4 in /.github/workflows in the patches-and-minor-upgrades group @dependabot
• [#139] Bump pip from 24.2 to 24.3.1 in /.github/workflows in the patches-and-minor-upgrades group @dependabot
• [#140] Bump pytest from 8.3.3 to 8.3.4 in the patches-and-minor-upgrades group @dependabot
• [#141] Bump poetry from 1.8.4 to 1.8.5 in /.github/workflows in the patches-and-minor-upgrades group @dependabot

4.0.0

What’s changed

🚨 Breaking changes

• [#35] Use poetry for python packaging and dependency management @trizz
• [#77] Drop python 3.7 support ~ Add python 3.11 support @robbinjanssen

🚀 Enhancements

• [#60] Add bad license checker @pufferfish42
• [#62] Added the Unlicense to the license checker @pufferfish42

🧰 Maintenance

• [#28] Automatically publish packages to PyPI @robbinjanssen
• [#30] Do not use Test PyPI @robbinjanssen
• [#36] Reorganize github actions @robbinjanssen

📚 Documentation

• [#85] Update and rename README.rst to README.md @robbinjanssen

⬆️ Dependency updates

47 changes

• [#29] Bump release-drafter/release-drafter from 5.15.0 to 5.16.1 @dependabot
• [#31] Bump release-drafter/release-drafter from 5.16.1 to 5.17.5 @dependabot
• [#32] Update release-drafter/release-drafter from 5.17.5 to v5 @dependabot
• [#33] Bump actions/setup-python from 2 to 3 @dependabot
• [#34] Bump actions/checkout from 2 to 3 @dependabot
• [#38] Bump pytest from 7.0.1 to 7.1.0 @dependabot
• [#39] Bump pytest from 7.1.0 to 7.1.1 @dependabot
• [#40] Bump actions/cache from 2 to 3 @dependabot
• [#41] Bump black from 22.1.0 to 22.3.0 @dependabot
• [#42] Bump pytest from 7.1.1 to 7.1.2 @dependabot
• [#43] Bump actions/setup-python from 3 to 4 @dependabot
• [#44] Bump requests from 2.27.1 to 2.28.0 @dependabot
• [#45] Bump black from 22.3.0 to 22.6.0 @dependabot
• [#46] Bump requests from 2.28.0 to 2.28.1 @dependabot
• [#49] Bump flake8 from 4.0.1 to 5.0.4 @dependabot
• [#50] Bump black from 22.6.0 to 22.8.0 @dependabot
• [#51] Bump pytest from 7.1.2 to 7.1.3 @dependabot
• [#52] Bump pytest-cov from 3.0.0 to 4.0.0 @dependabot
• [#53] Bump black from 22.8.0 to 22.10.0 @dependabot
• [#54] Bump pytest from 7.1.3 to 7.2.0 @dependabot
• [#55] Bump certifi from 2021.10.8 to 2022.12.7 @dependabot
• [#56] Bump black from 22.10.0 to 22.12.0 @dependabot
• [#57] Bump requests from 2.28.1 to 2.28.2 @dependabot
• [#58] Bump gitpython from 3.1.27 to 3.1.30 @dependabot
• [#59] Bump pytest from 7.2.0 to 7.2.1 @dependabot
• [#61] Bump black from 22.12.0 to 23.1.0 @dependabot
• [#63] Bump pytest from 7.2.1 to 7.2.2 @dependabot
• [#64] Bump bandit from 1.7.4 to 1.7.5 @dependabot
• [#65] Bump black from 23.1.0 to 23.3.0 @dependabot
• [#66] Bump pytest from 7.2.2 to 7.3.0 @dependabot
• [#67] Bump pytest from 7.3.0 to 7.3.1 @dependabot
• [#68] Bump requests from 2.28.2 to 2.29.0 @dependabot
• [#69] Bump requests from 2.29.0 to 2.30.0 @dependabot
• [#70] Bump requests from 2.30.0 to 2.31.0 @dependabot
• [#71] Bump pytest-cov from 4.0.0 to 4.1.0 @dependabot
• [#72] Bump pytest from 7.3.1 to 7.3.2 @dependabot
• [#73] Bump pytest from 7.3.2 to 7.4.0 @dependabot
• [#74] Bump gitpython from 3.1.30 to 3.1.32 @dependabot
• [#75] Bump pygments from 2.14.0 to 2.15.0 @dependabot
• [#76] Bump certifi from 2022.12.7 to 2023.7.22 @dependabot
• [#78] Bump pytest from 7.4.0 to 7.4.1 @dependabot
• [#79] Bump actions/checkout from 3 to 4 @dependabot
• [#80] Bump gitpython from 3.1.32 to 3.1.34 @dependabot
• [#81] Bump pytest from 7.4.1 to 7.4.2 @dependabot
• [#82] Bump gitpython from 3.1.34 to 3.1.35 @dependabot
• [#83] Bump black from 23.7.0 to 23.9.1 @dependabot
• [#84] Bump urllib3 from 2.0.4 to 2.0.6 @dependabot

3.0.3

What’s changed

🐛 Bug fixes

• #25 Decode JSON content when parsing API results @tomwijnroks

🧰 Maintenance

• #26 Add GitHub actions @robbinjanssen
• #27 Update version number @styxit

Dependency update

3.0.2 - 2021-08-06

Compare 3.0.1 - 3.0.2

Changed

• Dependencies have been updated. The old urllib3 version had a vulnerability that is now fixed.

Update dependencies

3.0.1 - 2020-10-05

Compare 3.0.0 - 3.0.1

Changed

• Dependencies have been updated.

Release v3

Breaking

• When multiple resources are returned from the API, an instance of ApiResourceSet is returned instead of a list. This class is traversable so unless the code does specific list things or type checks, no changes are necessary.

Added

• Add the total() method to resource sets to get the total number of resources (and not only the number of resources in the current resource set).
• Add next_page, previous_page, first_page and last_page methods to the ApiResourceSet for easy loading of paginated resource sets.
• Add a get_recursive method to the RequestBuilder to get the resource set including recursively the resource sets from the following pages.

Removed

• The store method for creating POST requests. (Deprecated since 2.0.0)

Add the ValidationException

2.1.0 - 2019-11-19

Compare 2.0.0 - 2.1.0

Changed

• Extend the ValidationException to contain all returned validation errors.

Release v2

2.0.0 - 2019-09-19

Compare 1.0.0 - 2.0.0

Breaking

• The Api prefix has been added from the following classes for consistency:
  • Resource --> ApiResource
  • ResourceIdentifier --> ApiResourceIdentifier

Added

• Support for PATCH and DELETE requests.

Deprecated

• The store method for creating POST requests is now deprecated. Use post instead.

1.0.0

Compare 1.0.0 - Unreleased

1.0.0 - 2019-08-14

Compare 0.0.5 - 1.0.0

Breaking

• The Client has been refactored to keep consistency between packages in different programming languages. See the updated documentation and examples.