Bump to v0.4.1

.github/workflows/ci.yml

@@ -64,3 +64,6 @@ jobs:
       - name: Upload to pypi
         run: |
           twine upload -u ${{ secrets.PYPI_USERNAME }} -p ${{ secrets.PYPI_PASSWORD }} dist/*
+      - name: Deploy docs
+        run: |
+          mkdocs gh-deploy

CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [0.4.1] - 2022-12-20
+
+### Added
+
+- Added the docs site at `https://sopherapps.github.io/pydantic-redis/`
+
+### Changed
+
+- Made the `shared` package protected
+
+### Fixed
+
 ## [0.4.0] - 2022-12-17
 
 ### Added
@@ -17,6 +29,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 - Changed redis index to use sorted sets instead of ordinary sets
 
+### Fixed
+
 ## [0.3.0] - 2022-12-15
 
 ### Added

docs/change-log.md

@@ -0,0 +1,88 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+## [0.4.1] - 2022-12-20
+
+### Added
+
+- Added the docs site at `https://sopherapps.github.io/pydantic-redis/`
+
+### Changed
+
+- Made the `shared` package protected
+
+### Fixed
+
+## [0.4.0] - 2022-12-17
+
+### Added
+
+- Added pagination
+
+### Changed
+
+- Changed redis index to use sorted sets instead of ordinary sets
+
+### Fixed
+
+## [0.3.0] - 2022-12-15
+
+### Added
+
+- Added asyncio support, to be got from the `pydantic_redis.asyncio` module
+
+### Changed
+
+- Moved the synchronous version to the `pydantic_redis.syncio` module, but kept its contents exposed in pydantic_redis
+  for backward-compatibility
+
+### Fixed
+
+## [0.2.0] - 2022-12-15
+
+### Added
+
+### Changed
+
+- Changed the `NESTED_MODEL_LIST_FIELD_PREFIX` to "___" and `NESTED_MODEL_TUPLE_FIELD_PREFIX` to "____"
+- Changed all queries (selects) to use lua scripts
+- Changed `Model.deserialize_partially` to receive data either as a dict or as a flattened list of key-values
+
+### Fixed
+
+## [0.1.8] - 2022-12-13
+
+### Added
+
+- Add support for model fields that are tuples of nested models 
+
+### Changed
+
+### Fixed
+
+## [0.1.7] - 2022-12-12
+
+### Added
+
+### Changed
+
+### Fixed
+
+- Fixed support for model properties that are *Optional* lists of nested models 
+- Fixed issue with field names being disfigured by `lstrip` when attempting to strip nested-mode-prefixes 
+
+## [0.1.6] - 2022-11-01
+
+### Added
+
+- Support for model properties that are lists of nested models 
+
+### Changed
+
+### Fixed

mkdocs.yml

@@ -40,6 +40,7 @@ nav:
   - 'Explanation':
       - explanation/why-use-orms.md
   - reference.md
+  - change-log.md
 
 markdown_extensions:
   - pymdownx.highlight:

pydantic_redis/__init__.py

@@ -26,4 +26,4 @@
 
 __all__ = [Store, RedisConfig, Model, asyncio]
 
-__version__ = "0.4.0"
+__version__ = "0.4.1"

setup.py

@@ -11,7 +11,7 @@
 # This call to setup() does all the work
 setup(
     name="pydantic-redis",
-    version="0.4.0",
+    version="0.4.1",
     description="This package provides a simple ORM for redis using pydantic-like models.",
     long_description=README,
     long_description_content_type="text/markdown",