diff --git a/README.md b/README.md index 6d817f7..1f9dab9 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,10 @@ You can install the library using `pip`: pip install jeb-utils --index-url https://repo.jcloud-services.ddns.net/simple/ --extra-index-url https://pypi.org/simple/ ``` +## Reference + +For the reference, see [here](docs/reference/) + ## Functions and classes ### `auth_utils`: Utilities for the jeb authentication - `load_cert_file`: Loads a certificate from a file @@ -74,53 +78,4 @@ pip install jeb-utils --index-url https://repo.jcloud-services.ddns.net/simple/ - `byte_to_bits`: Converts the byte to a tuple of bits. - `get_next_lower_integer_multiple`: Returns the next lower integer multiple. - `find_nearest_lower_number`: Finds the nearest lower number to the target from the list. -- `create_file_if_not_exists`: Creates a file if it does not exist. - -## Changelog -### Version 0.3.2 -- Bug fix: `jeb_utils.utils.is_valid_host` returned `None` instead of `False` if the host is not valid - -### Version 0.3.1 -- Fatal bug fix: `typing.Union` in `jeb_utils.utils` was used but not imported - -### Version 0.3.0 -- Make library backward compatible: use `typing.Union` instead of the `|` operator - -### Version 0.2.5 -- Update type hint `Sequence` in `jeb_utils.utils.find_nearest_lower_number` to `Sequence[int | float]` - -### Version 0.2.4 -- Add support for `signed=True` in `jeb_utils.utils.int_to_bytes` - -### Version 0.2.3 -- Bug fix: `is_valid_host`, `is_valid_port` and `validate_address_port` in `jeb_utils.utils` were not included in `__all__` - -### Version 0.2.2 -- Bug fix: jeb_utils.utils.is_number could return `True` even if the base is `0` which is mathematically incorrect. - -### Version 0.2.1 -- Add feature for validating addresses. - -### Version 0.2.0 -- Remove all the functions and classes that are now in jeb-server-utils. - -### Version 0.1.4 -- Bug fix: Due to a refactoring, `jeb_utils.jebp_utils.unpack_fields` did not work. - -### Version 0.1.3 -- Fatal bug fix: `jeb_utils.jeb_utils.validate_topic_name` has not returned `True` if the topic name is valid, it returned `None` (falsy). Now it returns `True` if the topic name is valid. - -### Version 0.1.2 -- Bug fix: `jeb_utils.mktopicpart` has tried to raise `jeb_utils.exceptions.exceptions.TopicNotFoundError` instead of `jeb_utils.exceptions.TopicNotFoundError` if the topic does not exist. - -### Version 0.1.1 -- Support for custom data paths (`jeb_utils.init`) - -### Version 0.1.0 -- First release -- `auth_utils` -- `crypto_utils` -- `exceptions` -- `jeb_utils` -- `jebp_utils` -- `utils` \ No newline at end of file +- `create_file_if_not_exists`: Creates a file if it does not exist. \ No newline at end of file diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md new file mode 100644 index 0000000..8849e5a --- /dev/null +++ b/docs/CHANGELOG.md @@ -0,0 +1,52 @@ +# Changelog + +## Version 0.3.3 +- Update package configuration + +## Version 0.3.2 +- Bug fix: `jeb_utils.utils.is_valid_host` returned `None` instead of `False` if the host is not valid + +## Version 0.3.1 +- Fatal bug fix: `typing.Union` in `jeb_utils.utils` was used but not imported + +## Version 0.3.0 +- Make library backward compatible: use `typing.Union` instead of the `|` operator + +## Version 0.2.5 +- Update type hint `Sequence` in `jeb_utils.utils.find_nearest_lower_number` to `Sequence[int | float]` + +## Version 0.2.4 +- Add support for `signed=True` in `jeb_utils.utils.int_to_bytes` + +## Version 0.2.3 +- Bug fix: `is_valid_host`, `is_valid_port` and `validate_address_port` in `jeb_utils.utils` were not included in `__all__` + +## Version 0.2.2 +- Bug fix: jeb_utils.utils.is_number could return `True` even if the base is `0` which is mathematically incorrect. + +## Version 0.2.1 +- Add feature for validating addresses. + +## Version 0.2.0 +- Remove all the functions and classes that are now in jeb-server-utils. + +## Version 0.1.4 +- Bug fix: Due to a refactoring, `jeb_utils.jebp_utils.unpack_fields` did not work. + +## Version 0.1.3 +- Fatal bug fix: `jeb_utils.jeb_utils.validate_topic_name` has not returned `True` if the topic name is valid, it returned `None` (falsy). Now it returns `True` if the topic name is valid. + +## Version 0.1.2 +- Bug fix: `jeb_utils.mktopicpart` has tried to raise `jeb_utils.exceptions.exceptions.TopicNotFoundError` instead of `jeb_utils.exceptions.TopicNotFoundError` if the topic does not exist. + +## Version 0.1.1 +- Support for custom data paths (`jeb_utils.init`) + +## Version 0.1.0 +- First release +- `auth_utils` +- `crypto_utils` +- `exceptions` +- `jeb_utils` +- `jebp_utils` +- `utils` \ No newline at end of file