Skip to content

Commit

Permalink
🔖 release v1.0.0
Browse files Browse the repository at this point in the history
## 1.0.0

* [CHORE] first stable release
  • Loading branch information
techouse committed May 27, 2024
1 parent 19e6cce commit ef24fc5
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 11 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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))
Expand Down
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion src/qs_codec/__init__.py
Original file line number Diff line number Diff line change
@@ -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
Expand Down
5 changes: 3 additions & 2 deletions src/qs_codec/decode.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""
Expand Down
2 changes: 1 addition & 1 deletion src/qs_codec/encode.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""
Expand Down

0 comments on commit ef24fc5

Please sign in to comment.