From ef24fc5d789c425b88772216f917c5a7c093c69e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Klemen=20Tu=C5=A1ar?= Date: Mon, 27 May 2024 18:43:30 +0100 Subject: [PATCH] :bookmark: release v1.0.0 ## 1.0.0 * [CHORE] first stable release --- CHANGELOG.md | 4 ++++ README.rst | 6 +++--- docs/README.rst | 6 +++--- pyproject.toml | 2 +- src/qs_codec/__init__.py | 2 +- src/qs_codec/decode.py | 5 +++-- src/qs_codec/encode.py | 2 +- 7 files changed, 16 insertions(+), 11 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 53c758a..43e723b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,7 @@ +## 1.0.0 + +* [CHORE] first stable release + ## 0.2.2 * [FEAT] `decode` returns `dict[str, Any]` instead of `dict` ([#4](https://github.com/techouse/qs_codec/pull/4)) diff --git a/README.rst b/README.rst index 109afe0..0828a62 100644 --- a/README.rst +++ b/README.rst @@ -35,10 +35,10 @@ dictionaries import qs_codec, typing as t def decode( - value: t.Optional[t.Union[str, t.Mapping]], - options: qs_codec.DecodeOptions = qs_codec.DecodeOptions(), + value: t.Optional[t.Union[str, t.Dict[str, t.Any]]], + options: DecodeOptions = DecodeOptions(), ) -> t.Dict[str, t.Any]: - """Decodes a str or Mapping into a Dict. + """Decodes a str or Dict[str, Any] into a Dict. Providing custom DecodeOptions will override the default behavior.""" pass diff --git a/docs/README.rst b/docs/README.rst index 380eb22..7b3b720 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -9,10 +9,10 @@ dictionaries import qs_codec, typing as t def decode( - value: t.Optional[t.Union[str, t.Mapping]], - options: qs_codec.DecodeOptions = qs_codec.DecodeOptions(), + value: t.Optional[t.Union[str, t.Dict[str, t.Any]]], + options: DecodeOptions = DecodeOptions(), ) -> t.Dict[str, t.Any]: - """Decodes a str or Mapping into a Dict. + """Decodes a str or Dict[str, Any] into a Dict. Providing custom DecodeOptions will override the default behavior.""" pass diff --git a/pyproject.toml b/pyproject.toml index 280fc68..91ddf71 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -20,7 +20,7 @@ keywords = [ "query-string", ] classifiers = [ - "Development Status :: 4 - Beta", + "Development Status :: 5 - Production/Stable", "Environment :: Web Environment", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", diff --git a/src/qs_codec/__init__.py b/src/qs_codec/__init__.py index 5b5247f..c3a2dc7 100644 --- a/src/qs_codec/__init__.py +++ b/src/qs_codec/__init__.py @@ -1,6 +1,6 @@ """A query string encoding and decoding library for Python. Ported from qs_codec for JavaScript.""" -__version__ = "0.2.2" +__version__ = "1.0.0" from .decode import decode from .encode import encode diff --git a/src/qs_codec/decode.py b/src/qs_codec/decode.py index 7121bcb..44bac3e 100644 --- a/src/qs_codec/decode.py +++ b/src/qs_codec/decode.py @@ -15,10 +15,11 @@ def decode( - value: t.Optional[t.Union[str, t.Dict[str, t.Any]]], options: DecodeOptions = DecodeOptions() + value: t.Optional[t.Union[str, t.Dict[str, t.Any]]], + options: DecodeOptions = DecodeOptions(), ) -> t.Dict[str, t.Any]: """ - Decodes a ``str`` or ``Mapping`` into a ``dict``. + Decodes a ``str`` or ``t.Dict[str, t.Any]`` into a ``dict``. Providing custom ``DecodeOptions`` will override the default behavior. """ diff --git a/src/qs_codec/encode.py b/src/qs_codec/encode.py index e2e7a0f..2368d4a 100644 --- a/src/qs_codec/encode.py +++ b/src/qs_codec/encode.py @@ -18,7 +18,7 @@ def encode(value: t.Any, options: EncodeOptions = EncodeOptions()) -> str: """ - Encodes ``Any`` object into a query ``str`` ing. + Encodes an object into a query string. Providing custom ``EncodeOptions`` will override the default behavior. """