docs: updated various documentation

updated changelog and README.md updated documentation dependency requirements
click-contrib · Nov 23, 2023 · 5830e5d · 5830e5d
1 parent 51aca96
commit 5830e5d
Show file tree

Hide file tree

Showing 5 changed files with 64 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 - The signature of `UrlParamType` bas been changed to match the changes made in the `validators.url` function.
+- The signature of `EmailParamType` bas been changed to match the changes made in the `validators.email` function.
 
 ### Deprecated
 

diff --git a/README.md b/README.md
@@ -21,9 +21,10 @@ and I ended adding more parameter types that can be useful for various scripts i
 pip install click-params
 ```
 
-click-params starts working from **python 3.7**. It has a few dependencies:
+click-params starts working from **python 3.8**. It has a few dependencies:
 - [click](https://click.palletsprojects.com/en/7.x/) >= 7.0
 - [validators](https://validators.readthedocs.io/en/latest/)
+- [deprecated](https://deprecated.readthedocs.io/en/latest/)
 
 ## Usage
 

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -1,10 +1,67 @@
 # Changelog
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+## [0.5.0] - 2023-11-23
+
+### Added
+
+- `UrlParamType` can now be directly imported. It allows users to customize the validation of urls 
+  passed to their custom CLI.
+
+### Changed
+
+- The signature of `UrlParamType` bas been changed to match the changes made in the `validators.url` function.
+- The signature of `EmailParamType` bas been changed to match the changes made in the `validators.email` function.
+
+### Deprecated
+
+- `PUBLIC_URL` type is now deprecated and will be removed in a next release.
+- `PublicUrlListParamType` class is now deprecated and will be removed in a next release.
+
+### Removed
+
+- Dropped support for python 3.7
+
+### Security
+
+- Upgrade `validators` dependency to 0.22.0 to prevent [CVE-2023-45813](https://nvd.nist.gov/vuln/detail/CVE-2023-45813).
+
+## [0.4.1] - 2023-02-19
+
+### Fixed
+
+- Fixed `ListParamType` to be able to parse the same input multiple times in a row (#23).
+
+## [0.4.0] - 2022-08-13
+
+### Added
+
+- All `ListParamType` subclasses have a new parameter `ignore_empty` that defaults to False.
+
+### Changed
+
+- Renamed `UnionParamType` to `FirstOf` and changed its signature.
+
+## [0.3.0] - 2022-03-14
+
+### Fixed
+
+- An issue when a user is prompted a value for a type inheriting `ListParamType`.
+
+### Removed
+
+- Support for python3.6
+
+## [0.2.0] - 2022-03-04
+
+### Added
+
+- A new base type: `UnionParamType`.
+
 ## [0.1.2] - 2021-05-16
 
 ### Changed

diff --git a/docs/installation.md b/docs/installation.md
@@ -12,6 +12,7 @@ The project has a few dependencies:
 
 - [click](https://click.palletsprojects.com/) >= 7.0
 - [validators](https://validators.readthedocs.io/en/latest/)
+- [deprecated](https://deprecated.readthedocs.io/en/latest/)
 
 !!! note
-    click-params works starting from **python 3.7**
+    click-params works starting from **python 3.8**
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,3 +1,4 @@
 click==8.0.0
 validators==0.18.2
+deprecated==1.2.14
 mkdocs-material==8.4.0