Release v4.0.0: Bump python version to 3.12, new features and big fix…

…es (#49)

## v4.0.0 - 2024-10-22
### What's Changed
**Full Changelog**: v3.0.2...v4.0.0 by @obervinov in #46
#### 💥 Breaking Changes
* bump python version to `3.12`
* some arguments of the `Users` class and the `Storage` class have been replaced. Detailed information can be found in the DEPRECATEDv3.md file
#### 🚀 Features
* bump all dependencies to the latest versions
* bump workflows version to `2.0.0`
* #44
* #47
#### 🐛 Bug Fixes
* #48
* #40

.github/workflows/pr.yaml

@@ -10,17 +10,8 @@ on:   # yamllint disable-line rule:truthy
       - '!main'
 
 jobs:
-  changelog:
-    uses: obervinov/_templates/.github/workflows/[email protected]
-
-  pylint:
-    uses: obervinov/_templates/.github/workflows/[email protected]
-
-  pytest:
-    uses: obervinov/_templates/.github/workflows/[email protected]
+  pr:
+    uses: obervinov/_templates/.github/workflows/[email protected]
 
   pyproject:
-    uses: obervinov/_templates/.github/workflows/[email protected]
-
-  pr:
-    uses: obervinov/_templates/.github/workflows/[email protected]
+    uses: obervinov/_templates/.github/workflows/[email protected]

.github/workflows/release.yaml

@@ -9,22 +9,5 @@ on:   # yamllint disable-line rule:truthy
       - closed
 
 jobs:
-  changelog:
-    uses: obervinov/_templates/.github/workflows/[email protected]
-
-  pylint:
-    uses: obervinov/_templates/.github/workflows/[email protected]
-
-  pytest:
-    uses: obervinov/_templates/.github/workflows/[email protected]
-
-  pyproject:
-    uses: obervinov/_templates/.github/workflows/[email protected]
-
-  create-release:
-    uses: obervinov/_templates/.github/workflows/[email protected]
-    needs: [changelog, pylint, pytest, pyproject]
-
-  milestone:
-    uses: obervinov/_templates/.github/workflows/[email protected]
-    needs: [create-release]
+  release:
+    uses: obervinov/_templates/.github/workflows/[email protected]

CHANGELOG.md

@@ -3,6 +3,22 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## v4.0.0 - 2024-10-22
+### What's Changed
+**Full Changelog**: https://github.com/obervinov/users-package/compare/v3.0.2...v4.0.0 by @obervinov in https://github.com/obervinov/users-package/pull/46
+#### 💥 Breaking Changes
+* bump python version to `3.12`
+* some arguments of the `Users` class and the `Storage` class have been replaced. Detailed information can be found in the [DEPRECATED.md](DEPRECATEDv3.md) file
+#### 🚀 Features
+* bump all dependencies to the latest versions
+* bump workflows version to `2.0.0`
+* [Feature request: Add support for a method that returns a dictionary of all users in the table](https://github.com/obervinov/users-package/issues/44)
+* [Feature request: Storage should not retrieve the database connection data from the vault itself](https://github.com/obervinov/users-package/issues/47)
+#### 🐛 Bug Fixes
+* [Bug: The application tries to use credentials to access the database that have already expired](https://github.com/obervinov/users-package/issues/48)
+* [Configuration `per_day` in RateLimit not working as expected](https://github.com/obervinov/users-package/issues/40)
+
+
 ## v3.0.2 - 2024-09-10
 ### What's Changed
 **Full Changelog**: https://github.com/obervinov/users-package/compare/v3.0.1...v3.0.2 by @obervinov in https://github.com/obervinov/users-package/pull/46
@@ -23,7 +39,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 #### 💥 Breaking Changes
 * [Feature request: Add an additional backend - `Postgres` to store historical user data](https://github.com/obervinov/users-package/issues/41)
 * Bump vault-package version to `3.0.0` (this version contains major changes)
-* Detailed information about the deprecated methods, constants, arguments, properties, and return values can be found in the [DEPRECATED.md](DEPRECATED.md) file
+* Detailed information about the deprecated methods, constants, arguments, properties, and return values can be found in the [DEPRECATED.md](DEPRECATEDv2.md) file
 * Changed logger level to `INFO` for messages when the user `RateLimit` is exceeded
 * Removed unused option to manually set `vault_client` attributes
 #### 🚀 Features

DEPRECATEDv3.md

@@ -0,0 +1,6 @@
+
+## Deprecated Arguments
+| Method | Reason for Deprecation | Date of Deprecation | Old Argument | New Argument |
+| ------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------ | -------------------------------------- | -------------------------------------- |
+| `Users()` | The `Users` class now expects new argument instead of `storage` dictionary | 2024-10-18 | `storage: dict` | `storage_connection` is psycopg2 connection object |
+| `Storage()` | The `Storage` class now expects new argument instead of `db_role` and `vault_client` | 2024-10-18 | `db_role: str`, `vault_client: VaultClient` | `db_connection` is psycopg2 connection object |

README.md

@@ -334,8 +334,8 @@ version = "1.0.0"
 description = ""
 
 [tool.poetry.dependencies]
-python = "^3.10"
-users = { git = "https://github.com/obervinov/users-package.git", tag = "v3.0.0" }
+python = "^3.12"
+users = { git = "https://github.com/obervinov/users-package.git", tag = "v4.0.0" }
 
 [build-system]
 requires = ["poetry-core"]
@@ -348,4 +348,4 @@ poetry install
 ## <img src="https://github.com/obervinov/_templates/blob/v1.0.5/icons/github-actions.png" width="25" title="github-actions"> GitHub Actions
 | Name  | Version |
 | ------------------------ | ----------- |
-| GitHub Actions Templates | [v1.2.8](https://github.com/obervinov/_templates/tree/v1.2.8) |
+| GitHub Actions Templates | [v2.0.0](https://github.com/obervinov/_templates/tree/v2.0.0) |

SECURITY.md

@@ -6,7 +6,8 @@ Versions supported to fix vulnerabilities
 
 | Version | Supported          |
 | ------- | ------------------ |
-| 3.x.x   | :white_check_mark: |
+| 4.x.x   | :white_check_mark: |
+| 3.x.x   | :x:                |
 | 2.x.x   | :x:                |
 | 1.x.x   | :x:                |