qs-codec 1.2.1__tar.gz → 1.2.3__tar.gz

{qs_codec-1.2.1 → qs_codec-1.2.3}/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 1.2.3
+
+* [CHORE] add highlights section to README and docs with key features and usage notes
+
+## 1.2.2
+
+* [CHORE] update pyproject.toml with improved metadata, optional dev dependencies, and wheel build config
+* [CHORE] add project logo to README and documentation
+
 ## 1.2.1
 
 * [FIX] fix top-level dot splitting in keys to preserve encoded dots and handle degenerate cases

qs_codec-1.2.1/README.rst → qs_codec-1.2.3/PKG-INFO

@@ -1,6 +1,55 @@
+Metadata-Version: 2.4
+Name: qs-codec
+Version: 1.2.3
+Summary: A query string encoding and decoding library for Python. Ported from qs for JavaScript.
+Project-URL: Homepage, https://techouse.github.io/qs_codec/
+Project-URL: Documentation, https://techouse.github.io/qs_codec/
+Project-URL: Repository, https://github.com/techouse/qs_codec.git
+Project-URL: Issues, https://github.com/techouse/qs_codec/issues
+Project-URL: Changelog, https://github.com/techouse/qs_codec/blob/master/CHANGELOG.md
+Project-URL: Sponsor, https://github.com/sponsors/techouse
+Project-URL: PayPal, https://paypal.me/ktusar
+Author-email: Klemen Tusar <techouse@gmail.com>
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Keywords: arrays,brackets,codec,form-urlencoded,nested,percent-encoding,qs,query,query-string,querystring,rfc3986,url,urldecode,urlencode
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Provides-Extra: dev
+Requires-Dist: black; extra == 'dev'
+Requires-Dist: isort; extra == 'dev'
+Requires-Dist: mypy>=1.15.0; extra == 'dev'
+Requires-Dist: pytest-cov>=6.0.0; extra == 'dev'
+Requires-Dist: pytest>=8.3.5; extra == 'dev'
+Requires-Dist: toml>=0.10.2; extra == 'dev'
+Requires-Dist: tox; extra == 'dev'
+Description-Content-Type: text/x-rst
+
 qs-codec
 ========
 
+
+.. image:: https://raw.githubusercontent.com/techouse/qs_codec/main/logo.png
+   :alt: qs-codec
+   :width: 256
+   :align: center
+
 A query string encoding and decoding library for Python.
 
 Ported from `qs <https://www.npmjs.com/package/qs>`__ for JavaScript.
@@ -9,6 +58,19 @@ Ported from `qs <https://www.npmjs.com/package/qs>`__ for JavaScript.
 |Test| |CodeQL| |Publish| |Docs| |codecov| |Codacy| |Black| |flake8| |mypy| |pylint| |isort| |bandit|
 |License| |Contributor Covenant| |GitHub Sponsors| |GitHub Repo stars|
 
+Highlights
+----------
+
+- Nested dictionaries & lists: ``foo[bar][baz]=qux`` ⇄ ``{'foo': {'bar': {'baz': 'qux'}}}``.
+- Multiple list formats: INDICES (``a[0]=x``), BRACKETS (``a[]=x``), REPEAT (``a=x&a=y``), COMMA (``a=x,y``) with optional comma round-trip.
+- Dot-notation: parse/encode keys like ``a.b=c`` as nested; option to **encode dots in keys** when using dot notation.
+- Charset handling: UTF-8 (default) and Latin-1; optional **charset sentinel** (``utf8=✓``) to auto-detect encoding.
+- Pluggable hooks: custom ``encoder``/``decoder`` callables; options to sort keys, filter output, and control percent-encoding (keys-only, values-only).
+- Nulls & empties: ``strict_null_handling`` and ``skip_nulls``; support for empty lists/arrays when desired.
+- Dates: ``serialize_date`` for ISO 8601 or custom (e.g., UNIX timestamp).
+- Safety limits: configurable nesting depth, parameter limit, and list index limit; optional strict-depth errors; duplicate-key strategies (combine/first/last).
+- Extras: numeric entity decoding (e.g. ``&#9786;`` → ☺), alternate delimiters/regex, and query-prefix helpers.
+
 Usage
 -----
 
@@ -976,6 +1038,25 @@ The default `format <https://techouse.github.io/qs_codec/qs_codec.models.html#qs
 
 --------------
 
+Other ports
+-----------
+
++----------------------------+---------------------------------------------------------------+-----------------+
+| Port                       | Repository                                                    | Package         |
++============================+===============================================================+=================+
+| Dart                       | `techouse/qs <https://github.com/techouse/qs>`__              | |pubdev|        |
++----------------------------+---------------------------------------------------------------+-----------------+
+| Kotlin / JVM + Android AAR | `techouse/qs-kotlin <https://github.com/techouse/qs-kotlin>`__| |maven-central| |
++----------------------------+---------------------------------------------------------------+-----------------+
+| Swift / Objective-C        | `techouse/qs-swift <https://github.com/techouse/qs-swift>`__  | |spm|           |
++----------------------------+---------------------------------------------------------------+-----------------+
+| .NET / C#                  | `techouse/qs-net <https://github.com/techouse/qs-net>`__      | |nuget|         |
++----------------------------+---------------------------------------------------------------+-----------------+
+| Node.js (original)         | `ljharb/qs <https://github.com/ljharb/qs>`__                  | |npm|           |
++----------------------------+---------------------------------------------------------------+-----------------+
+
+--------------
+
 Special thanks to the authors of
 `qs <https://www.npmjs.com/package/qs>`__ for JavaScript: - `Jordan
 Harband <https://github.com/ljharb>`__ - `TJ
@@ -1021,3 +1102,18 @@ Holowaychuk <https://github.com/visionmedia/node-querystring>`__
 .. |bandit| image:: https://img.shields.io/badge/security-bandit-blue.svg
    :target: https://github.com/PyCQA/bandit
    :alt: Security Status
+.. |pubdev| image:: https://img.shields.io/pub/v/qs_dart?logo=dart&label=pub.dev
+   :target: https://pub.dev/packages/qs_dart
+   :alt: pub.dev version
+.. |maven-central| image:: https://img.shields.io/maven-central/v/io.github.techouse/qs-kotlin?logo=kotlin&label=Maven%20Central
+   :target: https://central.sonatype.com/artifact/io.github.techouse/qs-kotlin
+   :alt: Maven Central version
+.. |spm| image:: https://img.shields.io/github/v/release/techouse/qs-swift?logo=swift&label=SwiftPM
+   :target: https://swiftpackageindex.com/techouse/qs-swift
+   :alt: Swift Package Manager version
+.. |nuget| image:: https://img.shields.io/nuget/v/QsNet?logo=dotnet&label=NuGet
+   :target: https://www.nuget.org/packages/QsNet
+   :alt: NuGet version
+.. |npm| image:: https://img.shields.io/npm/v/qs?logo=javascript&label=npm
+   :target: https://www.npmjs.com/package/qs
+   :alt: npm version

qs_codec-1.2.1/PKG-INFO → qs_codec-1.2.3/README.rst

@@ -1,39 +1,12 @@
-Metadata-Version: 2.4
-Name: qs-codec
-Version: 1.2.1
-Summary: A query string encoding and decoding library for Python. Ported from qs for JavaScript.
-Project-URL: Homepage, https://techouse.github.io/qs_codec/
-Project-URL: Documentation, https://techouse.github.io/qs_codec/
-Project-URL: Source, https://github.com/techouse/qs_codec
-Project-URL: Changelog, https://github.com/techouse/qs_codec/blob/master/CHANGELOG.md
-Project-URL: Sponsor, https://github.com/sponsors/techouse
-Project-URL: PayPal, https://paypal.me/ktusar
-Author-email: Klemen Tusar <techouse@gmail.com>
-License: BSD-3-Clause
-License-File: LICENSE
-Keywords: codec,qs,query,query-string,querystring,url
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Environment :: Web Environment
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: BSD License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: Implementation :: CPython
-Classifier: Topic :: Internet :: WWW/HTTP
-Classifier: Topic :: Software Development :: Libraries
-Requires-Python: >=3.9
-Description-Content-Type: text/x-rst
-
 qs-codec
 ========
 
+
+.. image:: https://raw.githubusercontent.com/techouse/qs_codec/main/logo.png
+   :alt: qs-codec
+   :width: 256
+   :align: center
+
 A query string encoding and decoding library for Python.
 
 Ported from `qs <https://www.npmjs.com/package/qs>`__ for JavaScript.
@@ -42,6 +15,19 @@ Ported from `qs <https://www.npmjs.com/package/qs>`__ for JavaScript.
 |Test| |CodeQL| |Publish| |Docs| |codecov| |Codacy| |Black| |flake8| |mypy| |pylint| |isort| |bandit|
 |License| |Contributor Covenant| |GitHub Sponsors| |GitHub Repo stars|
 
+Highlights
+----------
+
+- Nested dictionaries & lists: ``foo[bar][baz]=qux`` ⇄ ``{'foo': {'bar': {'baz': 'qux'}}}``.
+- Multiple list formats: INDICES (``a[0]=x``), BRACKETS (``a[]=x``), REPEAT (``a=x&a=y``), COMMA (``a=x,y``) with optional comma round-trip.
+- Dot-notation: parse/encode keys like ``a.b=c`` as nested; option to **encode dots in keys** when using dot notation.
+- Charset handling: UTF-8 (default) and Latin-1; optional **charset sentinel** (``utf8=✓``) to auto-detect encoding.
+- Pluggable hooks: custom ``encoder``/``decoder`` callables; options to sort keys, filter output, and control percent-encoding (keys-only, values-only).
+- Nulls & empties: ``strict_null_handling`` and ``skip_nulls``; support for empty lists/arrays when desired.
+- Dates: ``serialize_date`` for ISO 8601 or custom (e.g., UNIX timestamp).
+- Safety limits: configurable nesting depth, parameter limit, and list index limit; optional strict-depth errors; duplicate-key strategies (combine/first/last).
+- Extras: numeric entity decoding (e.g. ``&#9786;`` → ☺), alternate delimiters/regex, and query-prefix helpers.
+
 Usage
 -----
 
@@ -1009,6 +995,25 @@ The default `format <https://techouse.github.io/qs_codec/qs_codec.models.html#qs
 
 --------------
 
+Other ports
+-----------
+
++----------------------------+---------------------------------------------------------------+-----------------+
+| Port                       | Repository                                                    | Package         |
++============================+===============================================================+=================+
+| Dart                       | `techouse/qs <https://github.com/techouse/qs>`__              | |pubdev|        |
++----------------------------+---------------------------------------------------------------+-----------------+
+| Kotlin / JVM + Android AAR | `techouse/qs-kotlin <https://github.com/techouse/qs-kotlin>`__| |maven-central| |
++----------------------------+---------------------------------------------------------------+-----------------+
+| Swift / Objective-C        | `techouse/qs-swift <https://github.com/techouse/qs-swift>`__  | |spm|           |
++----------------------------+---------------------------------------------------------------+-----------------+
+| .NET / C#                  | `techouse/qs-net <https://github.com/techouse/qs-net>`__      | |nuget|         |
++----------------------------+---------------------------------------------------------------+-----------------+
+| Node.js (original)         | `ljharb/qs <https://github.com/ljharb/qs>`__                  | |npm|           |
++----------------------------+---------------------------------------------------------------+-----------------+
+
+--------------
+
 Special thanks to the authors of
 `qs <https://www.npmjs.com/package/qs>`__ for JavaScript: - `Jordan
 Harband <https://github.com/ljharb>`__ - `TJ
@@ -1054,3 +1059,18 @@ Holowaychuk <https://github.com/visionmedia/node-querystring>`__
 .. |bandit| image:: https://img.shields.io/badge/security-bandit-blue.svg
    :target: https://github.com/PyCQA/bandit
    :alt: Security Status
+.. |pubdev| image:: https://img.shields.io/pub/v/qs_dart?logo=dart&label=pub.dev
+   :target: https://pub.dev/packages/qs_dart
+   :alt: pub.dev version
+.. |maven-central| image:: https://img.shields.io/maven-central/v/io.github.techouse/qs-kotlin?logo=kotlin&label=Maven%20Central
+   :target: https://central.sonatype.com/artifact/io.github.techouse/qs-kotlin
+   :alt: Maven Central version
+.. |spm| image:: https://img.shields.io/github/v/release/techouse/qs-swift?logo=swift&label=SwiftPM
+   :target: https://swiftpackageindex.com/techouse/qs-swift
+   :alt: Swift Package Manager version
+.. |nuget| image:: https://img.shields.io/nuget/v/QsNet?logo=dotnet&label=NuGet
+   :target: https://www.nuget.org/packages/QsNet
+   :alt: NuGet version
+.. |npm| image:: https://img.shields.io/npm/v/qs?logo=javascript&label=npm
+   :target: https://www.npmjs.com/package/qs
+   :alt: npm version

{qs_codec-1.2.1 → qs_codec-1.2.3}/pyproject.toml

@@ -5,19 +5,17 @@ build-backend = "hatchling.build"
 [project]
 name = "qs-codec"
 description = "A query string encoding and decoding library for Python. Ported from qs for JavaScript."
-readme = "README.rst"
-license = { text = "BSD-3-Clause" }
+readme = { file = "README.rst", content-type = "text/x-rst" }
+license = "BSD-3-Clause"
+license-files = ["LICENSE"]
 requires-python = ">=3.9"
 authors = [
     { name = "Klemen Tusar", email = "techouse@gmail.com" },
 ]
 keywords = [
-    "qs",
-    "codec",
-    "url",
-    "query",
-    "querystring",
-    "query-string",
+    "qs", "codec", "url", "query", "querystring", "query-string",
+    "urlencode", "urldecode", "form-urlencoded", "percent-encoding",
+    "rfc3986", "arrays", "nested", "brackets"
 ]
 classifiers = [
     "Development Status :: 5 - Production/Stable",
@@ -36,17 +34,30 @@ classifiers = [
     "Programming Language :: Python :: Implementation :: CPython",
     "Topic :: Internet :: WWW/HTTP",
     "Topic :: Software Development :: Libraries",
+    "Typing :: Typed",
 ]
 dynamic = ["version"]
 
 [project.urls]
 Homepage = "https://techouse.github.io/qs_codec/"
 Documentation = "https://techouse.github.io/qs_codec/"
-Source = "https://github.com/techouse/qs_codec"
+Repository = "https://github.com/techouse/qs_codec.git"
+Issues = "https://github.com/techouse/qs_codec/issues"
 Changelog = "https://github.com/techouse/qs_codec/blob/master/CHANGELOG.md"
 Sponsor = "https://github.com/sponsors/techouse"
 PayPal = "https://paypal.me/ktusar"
 
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.3.5",
+    "pytest-cov>=6.0.0",
+    "mypy>=1.15.0",
+    "toml>=0.10.2",
+    "tox",
+    "black",
+    "isort"
+]
+
 [tool.hatch.version]
 path = "src/qs_codec/__init__.py"
 
@@ -63,6 +74,7 @@ include = [
 
 [tool.hatch.build.targets.wheel]
 packages = ["src/qs_codec"]
+include = ["src/qs_codec/py.typed"]
 
 [tool.black]
 line-length = 120
@@ -91,7 +103,7 @@ exclude = '''
 line_length = 120
 profile = "black"
 lines_after_imports = 2
-known_first_party = "qs"
+known_first_party = "qs_codec"
 skip_gitignore = true
 
 [tool.pytest.ini_options]

{qs_codec-1.2.1 → qs_codec-1.2.3}/requirements_dev.txt

@@ -2,4 +2,6 @@ pytest>=8.3.5
 pytest-cov>=6.0.0
 mypy>=1.15.0
 toml>=0.10.2
-tox
+tox
+black
+isort

{qs_codec-1.2.1 → qs_codec-1.2.3}/src/qs_codec/__init__.py

@@ -14,7 +14,7 @@ The package root re-exports the most commonly used functions and enums so you ca
 """
 
 # Package version (PEP 440). Bump in lockstep with distribution metadata.
-__version__ = "1.2.1"
+__version__ = "1.2.3"
 
 from .decode import decode, load, loads
 from .encode import dumps, encode