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.

Sort by field

Added possibility to retrieve sorted results from the API.

Get or set relationships

0.0.3 - 2018-06-26

Compare 0.0.2 - 0.0.3

Added

• Ready to use examples to get ticket details.
• Individual methods to set or get relationships from a resource object.

Changed

• Most class variables changed to instance variables.
  This enforces the defaults to be set, instead of using the same variables from another instance.