diff --git a/CHANGELOG.md b/CHANGELOG.md index ccf7cca..a8d1f0e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [1.1.6] + +### Added + +- Interactive demo page powered by Pyodide - try nestedutils directly in your browser without installation +- Demo page includes examples for all core functions (`get_at`, `set_at`, `exists_at`, `delete_at`) with real-time JSON editing +- Added interactive demo badge and link to README + ## [1.1.5] ### Changed @@ -112,6 +120,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Immutable container protection (tuples cannot be modified) - Safe list deletion (requires explicit `allow_list_mutation=True` flag) +[1.1.6]: https://github.com/ysskrishna/nestedutils/compare/v1.1.5...v1.1.6 [1.1.5]: https://github.com/ysskrishna/nestedutils/compare/v1.1.4...v1.1.5 [1.1.4]: https://github.com/ysskrishna/nestedutils/compare/v1.1.3...v1.1.4 [1.1.3]: https://github.com/ysskrishna/nestedutils/compare/v1.1.2...v1.1.3 diff --git a/README.md b/README.md index 2d1bbf1..0b0ee36 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,12 @@ [![PyPI](https://img.shields.io/pypi/v/nestedutils)](https://pypi.org/project/nestedutils/) [![PyPI Downloads](https://static.pepy.tech/personalized-badge/nestedutils?period=total&units=INTERNATIONAL_SYSTEM&left_color=GREY&right_color=BLUE&left_text=downloads)](https://pepy.tech/projects/nestedutils) [![Documentation](https://img.shields.io/badge/docs-ysskrishna.github.io%2Fnestedutils-blue.svg)](https://ysskrishna.github.io/nestedutils/) +[![Interactive Demo](https://img.shields.io/badge/demo-Try%20it%20now!-green.svg)](https://ysskrishna.github.io/nestedutils/demo/) The lightweight Python library for safe, simple, dot-notation access to nested dicts and lists. Effortlessly get, set, and delete values deep in your complex JSON, API responses, and config files without verbose error-checking or handling KeyError exceptions. +> 🚀 **Try it interactively in your browser!** Test the library with our [Interactive Demo](https://ysskrishna.github.io/nestedutils/demo/) - no installation required. + ![OG Image](https://raw.githubusercontent.com/ysskrishna/nestedutils/main/media/og.png) ## Why nestedutils? @@ -279,6 +282,7 @@ These limits help protect against accidental memory exhaustion or performance is - **PyPI**: [pypi.org/project/nestedutils](https://pypi.org/project/nestedutils/) - **Documentation**: [ysskrishna.github.io/nestedutils](https://ysskrishna.github.io/nestedutils/) +- **Interactive Demo**: [ysskrishna.github.io/nestedutils/demo/](https://ysskrishna.github.io/nestedutils/demo/) - **Repository**: [github.com/ysskrishna/nestedutils.git](https://github.com/ysskrishna/nestedutils.git) - **Issues**: [github.com/ysskrishna/nestedutils/issues](https://github.com/ysskrishna/nestedutils/issues) diff --git a/docs/demo.md b/docs/demo.md new file mode 100644 index 0000000..2ed8b50 --- /dev/null +++ b/docs/demo.md @@ -0,0 +1,530 @@ +--- +title: Interactive Demo +description: "Try nestedutils Python library in your browser. No installation required. Test dot-notation access to nested dictionaries and lists. Safely get, set, delete, and check existence of values in complex nested data structures." +keywords: + - interactive demo + - test nested data access + - online nested utils + - try nestedutils + - browser demo + - test dot notation + - validate nested paths + - test get_at set_at + - nested dictionary demo + - nested list demo +--- + +# Interactive Demo + +Try the `nestedutils` library directly in your browser! This page uses [Pyodide](https://pyodide.org/) to run Python in the browser. + + + +
+

Loading Pyodide...

+
+
+ + + + + + + + diff --git a/media/og.png b/media/og.png index 0ff6be8..2c47f3c 100644 Binary files a/media/og.png and b/media/og.png differ diff --git a/mkdocs.yml b/mkdocs.yml index 3f04215..53c86f4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -11,6 +11,7 @@ docs_dir: docs nav: - Home: index.md + - Interactive Demo: demo.md - API Reference: api-reference.md - Contributing: CONTRIBUTING.md - Changelog: CHANGELOG.md diff --git a/pyproject.toml b/pyproject.toml index e627cf1..0541ac9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "nestedutils" -version = "1.1.5" +version = "1.1.6" description = "The lightweight Python library for safe, simple, dot-notation access to nested dicts and lists. Effortlessly get, set, and delete values deep in your complex JSON, API responses, and config files without verbose error-checking or handling KeyError exceptions." readme = "README.md" requires-python = ">=3.8" diff --git a/uv.lock b/uv.lock index 6fc029f..fae511d 100644 --- a/uv.lock +++ b/uv.lock @@ -837,7 +837,7 @@ wheels = [ [[package]] name = "nestedutils" -version = "1.1.5" +version = "1.1.6" source = { editable = "." } [package.dev-dependencies]